WebLogicMBeanServerServiceConfiguration


1   /*
2    * The contents of this file are subject to the Sapient Public License
3    * Version 1.0 (the "License"); you may not use this file except in compliance
4    * with the License. You may obtain a copy of the License at
5    * http://carbon.sf.net/License.html.
6    *
7    * Software distributed under the License is distributed on an "AS IS" basis,
8    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9    * the specific language governing rights and limitations under the License.
10   *
11   * The Original Code is The Carbon Component Framework.
12   *
13   * The Initial Developer of the Original Code is Sapient Corporation
14   *
15   * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16   */
17  
18  package org.sape.carbon.services.jmx.server.weblogic;
19  
20  import org.sape.carbon.core.component.ComponentConfiguration;
21  
22  
23  /**
24   * This is the configuration for the WebLogicMBeanServerService.
25   * <p>
26   * The most common way to use this service is either to leave it
27   * using the standard component configuration or leave all values
28   * in this blank.  This will cause the InitialContext to be built
29   * with no values in the environment and hence use the Principal/Credential
30   * that was used to start WebLogic.
31   * </p>
32   * <p>
33   * If another principal/credential is needed this configuration may be
34   * used to specificy it.  It will authenticate against the WebLogic
35   * security service.
36   * </p>
37   *
38   * @since carbon 1.0
39   * @author Greg Hinkle, January 2002
40   * @version $Revision: 1.4 $($Author: dvoet $ / $Date: 2003/05/05 21:21:32 $)
41   * <br>Copyright 2002 Sapient
42   */
43  public interface WebLogicMBeanServerServiceConfiguration
44      extends ComponentConfiguration {
45      /**
46       * Accessor method for retrieving the <code>InitialContextFactory</code>
47       * to retreive proper InitialContext.
48       * <p>
49       * Leaving this item empty will not set an InitialContextFactory on the
50       * InitialContextObject.
51       * </p>
52       * @return String The name of the <code>InitialContextFactory</code>
53       * associated with this home factory
54       */
55      String   getInitialContextFactory();
56  
57      /**
58       * <p>Mutator method for setting the <code>InitialContextFactory</code>
59       * associated with this home factory.</p>
60       * @param initialContextFactory The name of the class to be used as the
61       * <code>InitialContextFactory</code> for this MBeanServer fetcher factory
62       */
63      void setInitialContextFactory(String   initialContextFactory);
64  
65      /**
66       * <p>Accessor method for retrieving the default principal associated with
67       * this MBeanServer.</p>
68       * <p>
69       * Leaving this item empty will not set a principal on the
70       * InitialContext Object.
71       * </p>
72       * @return String The default principal associated with this MBeanServer
73       */
74      String   getPrincipal();
75  
76      /**
77       * <p>Mutator method for setting the default principal associated with
78       * this MBeanServer.</p>
79       * @param principal The default principal
80       */
81      void setPrincipal(String   principal);
82  
83      /**
84       * <p>Accessor method for retrieving the default credential associated with
85       * this MBeanServer.</p>
86       * <p>
87       * Leaving this item empty will not set a credential on the
88       * InitialContext Object.
89       * </p>
90       * @return String The default credentials associated with this MBeanServer
91       */
92      String   getCredentials();
93  
94      /**
95       * <p>Mutator method for setting the default credentials associated with
96       * this MBeanServer.</p>
97       * @param credentials The default credentials
98       */
99      void setCredentials(String   credentials);
100 }
101
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags