|
| |
|
| java.lang.Object
 org.obe.util.CommonConfig
org.obe.client.api.ClientConfig
| ClientConfig | | final public class ClientConfig extends CommonConfig (Code) | | Provides access to OBE client configuration information. OBE is configured
by several XML and properties files, which can either be located in the OBE
configuration directory or in the META-INF/services directory in
obeconfig.jar. Resources in the latter location are accessed via this
class's ClassLoader. The OBE configuration directory can be specified by the
system property "obe.config.dir", defaulting to the current
directory. Loose files take precedence over resources in obeconfig.jar.
The obe.properties file contains the OBE client configuration.
author:
Adrian Price |
| Method Summary | |
| public static String | getJAASCallbackHandlerClass()
Returns the name of the JAAS callback handler to use for client
authentication.
The setting reflects the string value of the configuration property
obe.client.jaas.callback.handler. | | public static String | getJAASCallerPrincipalClass()
Returns the name of the javax.security.Principal class from
which to infer the primary identity of an authenticated subject. | | public static String | getJAASConfig()
Returns the name of the JAAS configuration entry to use for client
authentication. | | public static String | getJMSQueueConnectionFactory()
Returns the JNDI name of the JMS queue connection factory for clients. | | public static String | getJMSTopicConnectionFactory()
Returns the JNDI name of the JMS topic connection factory for clients. | | public static String | getJNDIInitialContextFactoryClass()
Returns an override for the JNDI property
java.naming.factory.initial. | | public static String | getServerHostURL()
Returns the OBE server host URL. | | public static boolean | useSTDIO()
Whether client-side tool agents should use STDIO for user interactions.
The setting reflects the boolean value of the configuration property
obe.client.stdio. |
| JAAS_CALLBACK_HANDLER_PROP | | final public static String JAAS_CALLBACK_HANDLER_PROP(Code) | | Property key for the name of a JAAS callback handler class.
|
| JAAS_CALLER_PRINCIPAL_CLASS_PROP | | final public static String JAAS_CALLER_PRINCIPAL_CLASS_PROP(Code) | | Property key for the primary JAAS principal class.
|
| JAAS_CONFIG_PROP | | final public static String JAAS_CONFIG_PROP(Code) | | Property key for the JAAS login configuration entry to use.
|
| JMS_QUEUE_CON_FACTORY_PROP | | final public static String JMS_QUEUE_CON_FACTORY_PROP(Code) | | Property key for the public JNDI name of a JMS queue connection factory.
|
| JMS_TOPIC_CON_FACTORY_PROP | | final public static String JMS_TOPIC_CON_FACTORY_PROP(Code) | | Property key for the public JNDI name of a JMS topic connection factory.
|
| JNDI_INITIAL_CONTEXT_FACTORY_PROP | | final public static String JNDI_INITIAL_CONTEXT_FACTORY_PROP(Code) | | Property key for configuring an override to the default JNDI initial
context factory whilst preserving the value of the latter.
|
| SERVER_HOST_URL_PROP | | final public static String SERVER_HOST_URL_PROP(Code) | | Property key for the OBE server host URL.
|
| USE_STDIO_PROP | | final public static String USE_STDIO_PROP(Code) | | Property key for whether client-side tool agents should use STDIO for
user interactions.
|
| getJAASCallbackHandlerClass | | public static String getJAASCallbackHandlerClass()(Code) | | Returns the name of the JAAS callback handler to use for client
authentication.
The setting reflects the string value of the configuration property
obe.client.jaas.callback.handler. The implementing class
must have a public constructor that takes the following arguments:
(String url, String username, String password)
JAAS callback handler class name, defaulting to"org.obe.client.api.base.OBECallbackHandler".
See Also: ClientConfig.JAAS_CALLBACK_HANDLER_PROP |
| getJAASCallerPrincipalClass | | public static String getJAASCallerPrincipalClass()(Code) | | Returns the name of the javax.security.Principal class from
which to infer the primary identity of an authenticated subject. If
null, the client uses the first non-group principal in the
authenticated subject.
The setting reflects the string value of the configuration property
obe.jaas.caller.principal.class.
JAAS callback handler class name, defaulting to null.
See Also: ClientConfig.JAAS_CALLER_PRINCIPAL_CLASS_PROP |
| getJAASConfig | | public static String getJAASConfig()(Code) | | Returns the name of the JAAS configuration entry to use for client
authentication.
The setting reflects the string value of the configuration property
obe.client.jaas.config.
JAAS configuration entry name, defaulting to "other".
See Also: ClientConfig.JAAS_CONFIG_PROP |
| getJMSQueueConnectionFactory | | public static String getJMSQueueConnectionFactory()(Code) | | Returns the JNDI name of the JMS queue connection factory for clients.
The setting reflects the string value of the configuration property
obe.jms.queue.connection.factory.
JMS connection factory JNDI name, defaulting to"ConnectionFactory".
See Also: ClientConfig.JMS_QUEUE_CON_FACTORY_PROP |
| getJMSTopicConnectionFactory | | public static String getJMSTopicConnectionFactory()(Code) | | Returns the JNDI name of the JMS topic connection factory for clients.
The setting reflects the string value of the configuration property
obe.jms.topic.connection.factory.
JMS connection factory JNDI name, defaulting to"ConnectionFactory".
See Also: ClientConfig.JMS_TOPIC_CON_FACTORY_PROP |
| getJNDIInitialContextFactoryClass | | public static String getJNDIInitialContextFactoryClass()(Code) | | Returns an override for the JNDI property
java.naming.factory.initial. Generally speaking there is no
reason to set this property. It should only be used if the OBE client
needs to bypass the standard JNDI initial context factory as specified
by the system property java.naming.factory.initial. For
example, certain RPC tunnelling protocols wrap default JNDI objects with
their own marshalling mechanism.
The setting reflects the string value of the configuration property
obe.client.java.naming.factory.initial.
JAAS callback handler class name, defaulting to null.
See Also: ClientConfig.JNDI_INITIAL_CONTEXT_FACTORY_PROP |
| getServerHostURL | | public static String getServerHostURL()(Code) | | Returns the OBE server host URL.
The setting reflects the string value of the configuration property
obe.server.host.
Server host name, defaulting to"jnp://localhost:1099".
See Also: ClientConfig.SERVER_HOST_URL_PROP |
| useSTDIO | | public static boolean useSTDIO()(Code) | | Whether client-side tool agents should use STDIO for user interactions.
The setting reflects the boolean value of the configuration property
obe.client.stdio. Default is false.
true to interact via STDIO, false topresent a graphical UI.
See Also: ClientConfig.USE_STDIO_PROP |
|
|
|