weblogic.jndi
Class Environment

java.lang.Object
  weblogic.jndi.Environment

All Implemented Interfaces:

Externalizable, Serializable, ClientEnvironment

public final class Environment
extends Object
implements Externalizable, ClientEnvironment

The Environment class represents the properties used to create an initial Context. It provides type-safe methods to set and get common JNDI properties and a convenient way to create a new initial Context. Although this class uses WLInitialContextFactory as its default factory, it may be used to create an initial Context using any legal factory.

Here's an example of how to create an initial context:

   Hashtable props = new Hashtable();
   props.put(Context.INITIAL_CONTEXT_FACTORY,
             "weblogic.jndi.WLInitialContextFactory");
   props.put(Context.PROVIDER_URL,         "t3://weblogic:7001");
   props.put(Context.SECURITY_PRINCIPAL,   "fred");
   props.put(Context.SECURITY_CREDENTIALS, "seafood");
   Context ctx = new InitialContext(props);

  Environment env = new Environment();
   env.setProviderUrl("t3://weblogicServer:7001");
   env.setSecurityPrincipal("fred");
   env.setSecurityCredentials("seafood");
   Context ctx = env.getInitialContext();

See Also:

Serialized Form

DEFAULT_INITIAL_CONTEXT_FACTORY

public static final String DEFAULT_INITIAL_CONTEXT_FACTORY

The default (WebLogic) initial context.

See Also:

Constant Field Values

LOCAL_URL_PROTOCOL

public static final String LOCAL_URL_PROTOCOL

See Also:

Constant Field Values

Environment

public Environment()

Constructs an Environment with default properties, that is, with a WebLogic initial context. If unset, the properties for principal and credentials default to anonymous/anonymous, and the provider URL defaults to "t3://localhost:7001".

Environment

public Environment(Hashtable properties)

Constructs an Environment and initializes it with the properties contained in the specified Hashtable.

Parameters:

properties - Hashtable containing initial properties

getProperties

public Hashtable getProperties()

Returns the properties associated with an Environment as a Hashtable.

Specified by:

getProperties in interface ClientEnvironment

Returns:

Hashtable

getInitialContext

public final Context getInitialContext()
                                throws NamingException

Returns an initial context based on the properties in an Environment.

Returns:

Initial context

Throws:

NamingException - if the initial context cannot be obtained

getContext

public final Context getContext()
                         throws NamingException

Description copied from interface: ClientEnvironment

Returns a context that can be used with this environment. Note that the context to the system identified in the properties is only gotten once. Subsequent calls to this method will always return the previously returned context. No new context will be gotten once the initial context has been established. Create a new ClientEnvironment if you want to attempt a different connection to a remote naming context.

Specified by:

getContext in interface ClientEnvironment

Returns:

A naming context that can be used by this client

Throws:

NamingException

getContext

public final Context getContext(String contextName)
                         throws NamingException

Returns a subcontext of the initial context with the specified name.

Parameters:

contextName - of the context to retrieve

Returns:

Initial context

Throws:

NamingException - if the initial context cannot be obtained

getInitialContextFactory

public String getInitialContextFactory()
                                throws IllegalArgumentException

Returns the value of Context.INITIAL_CONTEXT_FACTORY. If the property has not been set and is not defined as a system property, returns the default initial context factory (weblogic.jndi.WLInitialConextFactory).

Returns:

Context factory name

Throws:

IllegalArgumentException - if the context name is unavailable or invalid at runtime

See Also:

Context.INITIAL_CONTEXT_FACTORY

setInitialContextFactory

public final void setInitialContextFactory(String factoryName)

Sets the Context.INITIAL_CONTEXT_FACTORY property value to the value of factoryName.

Parameters:

factoryName - Initial context factory name

See Also:

Context.INITIAL_CONTEXT_FACTORY

getProviderUrl

public final String getProviderUrl()

Returns the Context.PROVIDER_URL property value. Note that this property need not be set to create a WLContext from code running on the server.

Returns:

Provider URL

See Also:

Context.PROVIDER_URL

setProviderUrl

public final void setProviderUrl(String url)

Sets the Context.PROVIDER_URL property value to the value of the argument url.

Parameters:

url - Provider url

See Also:

Context.PROVIDER_URL

setProviderURL

public final void setProviderURL(String url)

Description copied from interface: ClientEnvironment

Sets the Context.PROVIDER_URL property

Specified by:

setProviderURL in interface ClientEnvironment

Parameters:

url - The url to use with this environment

getDelegateEnvironment

public final Hashtable getDelegateEnvironment()
                                       throws IllegalArgumentException

Returns the value of the WLContext.DELEGATE_ENVIRONMENT property.

Returns:

Hashtable of properties for delegate environment

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

WLContext.DELEGATE_ENVIRONMENT

setDelegateEnvironment

public final void setDelegateEnvironment(Hashtable delegateEnv)

Sets the WLContext.DELEGATE_ENVIRONMENT property to the value of the argument delegateEnv.

Parameters:

delegateEnv - Hashtable of properties

See Also:

WLContext.DELEGATE_ENVIRONMENT

getSecurityPrincipal

public final String getSecurityPrincipal()
                                  throws IllegalArgumentException

Returns the value of the Context.SECURITY_PRINCIPAL property. If unset, defaults to guest.

Returns:

String (principal name)

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

Context.SECURITY_PRINCIPAL

setSecurityPrincipal

public final void setSecurityPrincipal(String principal)

Sets the Context.SECURITY_PRINCIPAL property to the value of the argument principal.

Specified by:

setSecurityPrincipal in interface ClientEnvironment

Parameters:

principal - Username

See Also:

Context.SECURITY_PRINCIPAL

getSecurityCredentials

public final Object getSecurityCredentials()
                                    throws IllegalArgumentException

Returns the Context.SECURITY_CREDENTIAL property value.

Returns:

Password string, Certificate or UserInfo

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

Context.SECURITY_PRINCIPAL

setSecurityCredentials

public final void setSecurityCredentials(Object password)

Sets the value of the Context.SECURITY_CREDENTIAL property to the value of the argument password.

Specified by:

setSecurityCredentials in interface ClientEnvironment

Parameters:

password - Password (String)

See Also:

Context.SECURITY_CREDENTIALS

getSecurityUser

public final UserInfo getSecurityUser()
                               throws IllegalArgumentException

Returns the UserInfo for the principal assigned to the Context.SECURITY_PRINCIPAL property.

Returns:

UserInfo object

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

setSecurityUser

public final void setSecurityUser(UserInfo user)

getSubject

public AbstractSubject getSubject()

Description copied from interface: ClientEnvironment

Gets the subject that has been associated with this thread, or null if there has not been one.

Specified by:

getSubject in interface ClientEnvironment

Returns:

A subject if one has been pushed onto the stack

getCreateIntermediateContexts

public final boolean getCreateIntermediateContexts()
                                            throws IllegalArgumentException

Returns the value of the WLContext.CREATE_INTERMEDIATE_CONTEXTS property.

Returns:

True if intermediate contexts are in use

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

WLContext.CREATE_INTERMEDIATE_CONTEXTS

setCreateIntermediateContexts

public final void setCreateIntermediateContexts(boolean flag)
                                         throws IllegalArgumentException

Set the WLContext.CREATE_INTERMEDIATE_CONTEXTS property to the String equivalent of the boolean argument flag.

Parameters:

flag - to turn on use of intermediate contexts

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

WLContext.CREATE_INTERMEDIATE_CONTEXTS

getReplicateBindings

public final boolean getReplicateBindings()
                                   throws IllegalArgumentException

Returns the value of the WLContext.REPLICATE_BINDINGS property.

Returns:

True if replicated bindings are in use

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

WLContext.REPLICATE_BINDINGS

setReplicateBindings

public final void setReplicateBindings(boolean enable)

Sets the WLContext.REPLICATE_BINDINGS property to the String equivalent of the boolean argument enable.

Parameters:

enable - True to enable replicated bindings

See Also:

WLContext.REPLICATE_BINDINGS

getPinToPrimaryServer

public final boolean getPinToPrimaryServer()
                                    throws IllegalArgumentException

Returns the value of the WLContext.PIN_TO_PRIMARY_SERVER property.

Returns:

True if context will only connect to the primary server.

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

WLContext.PIN_TO_PRIMARY_SERVER

setPinToPrimaryServer

public final void setPinToPrimaryServer(boolean enable)

Sets the WLContext.PIN_TO_PRIMARY_SERVER property to the String equivalent of the boolean argument enable.

Parameters:

enable - True to force use of primary server

See Also:

WLContext.PIN_TO_PRIMARY_SERVER

setEnableServerAffinity

public final void setEnableServerAffinity(boolean enable)

Sets the WLContext.ENABLE_SERVER_AFFINITY property to the String equivalent of the boolean argument enable.

Specified by:

setEnableServerAffinity in interface ClientEnvironment

Parameters:

enable - True to force use of server affinity

See Also:

WLContext.ENABLE_SERVER_AFFINITY

getEnableServerAffinity

public final boolean getEnableServerAffinity()

Returns the value of the WLContext.ENABLE_SERVER_AFFINITY property.

Returns:

True if context should try to reuse existing connections & note create new ones to a cluster

Throws:

IllegalArgumentException - if the property is unavailable or invalid at runtime

See Also:

WLContext.ENABLE_SERVER_AFFINITY

setRequestTimeout

public final void setRequestTimeout(long timeout)

Set the request timeout value in milliseconds. JNDI requests that fail to get a response within the timeout value will fail with RequestTimeoutException. A value of 0 implies that request will never timeout.

Parameters:

timeout - value in milliseconds.

getRequestTimeout

public final long getRequestTimeout()

Get the request timeout value.

Returns:

timeout value in milliseconds

See Also:

Environment.setRequestTimeout(long)

setRMIClientTimeout

public final void setRMIClientTimeout(long timeout)

getRMIClientTimeout

public final long getRMIClientTimeout()

Get the request timeout value.

Returns:

timeout value in milliseconds

See Also:

Environment.setRequestTimeout(long)

getString

public final String getString(String name)
                       throws IllegalArgumentException

Gets the value of the specified property as a String.

Parameters:

name - Name of property to retrieve

Returns:

Value of the property as a String

Throws:

IllegalArgumentException - if the property value is not a String

getBoolean

public final boolean getBoolean(String name,
                                boolean defaultValue)
                         throws IllegalArgumentException

Gets the value of the specified property as a boolean. Returns the argument defaultValue as a default if the property is not available or invalid.

Parameters:

name - Name of property to retrieve

defaultValue - Default value for the property

Returns:

True if the property value is true

Throws:

IllegalArgumentException - if the context name is unavailable or invalid at runtime

IllegalArgumentException - if the property value is not "true" or "false"

setSSLRootCAFingerprints

public final void setSSLRootCAFingerprints(String fps)

Establishes a set of trusted certificate authorities on the current thread. The value specified is a set of fingerprints (MD5) of the authority's certificates encoded as a comma-separated string of hex values.

Parameters:

fps - MD5 fingerprints of certificate(s)

setSSLRootCAFingerprints

public final void setSSLRootCAFingerprints(byte[][] fps)

Establishes a set of trusted certificate authorities on the current thread. The value specified is a set of fingerprints (MD5) of the authorities' certificates encoded as a byte[][] value.

Parameters:

fps - MD5 fingerprints of certificates

getSSLRootCAFingerprints

public final byte[][] getSSLRootCAFingerprints()

Returns the fingerprints of the certificates of trusted authorities associated with the current thread.

Returns:

Encoded byte array of authorities' certificates

setSSLServerName

public final void setSSLServerName(String name)

Sets an expected name on the current thread for the SSL server. It will be compared against the common name field in the certificate presented by the SSL server. This is typically the WebLogic Server's DNS name, e.g., www.weblogic.com.

Parameters:

name - Domain name of an SSL server

getSSLServerName

public final String getSSLServerName()

Gets the specified expected name from the current thread of the SSL server. If non-null, it will be compared against the common name field in the certificate presented by the SSL server. This is typically the WebLogic Server's DNS name, e.g., www.weblogic.com.

Returns:

Domain name of an SSL server

getSSLClientCertificate

public final Object getSSLClientCertificate()
                                     throws IOException

Returns an RSA private key and chain of X.509 certificates set for SSL client authentication on the current thread. The array of input streams are DER encoded values, the first of which is a private key, followed by X.509 certificates. All but the first of the certificates are issuer certificates for the previous certificate.

Throws:

IOException

See Also:

PEMInputStream, BufferedInputStream

setSSLClientCertificate

public final void setSSLClientCertificate(InputStream[] chain)

Sets an RSA private key and chain of X.509 certificates for SSL client authentication on the current thread. The array of input streams passed as an argument are DER encoded values, the first of which is a private key, followed by X.509 certificates. All but the first of the certificates are issuer certificates for the previous certificate.

The InputStreams you use must support mark and reset. If you have PEM-encoded data, you can wrap your InputStreams in PEMInputStream classes before passing them in here.

Parameters:

chain - Array of InputStreams of DER encoded values

See Also:

PEMInputStream, BufferedInputStream

setSSLClientKeyPassword

public final void setSSLClientKeyPassword(String pass)

Sets the password for an encrypted RSA private key on the current thread. If you aren't using an encrypted private key then you don't need to set this value.

Parameters:

pass - Password for private key

getSSLClientKeyPassword

public final Object getSSLClientKeyPassword()

Deprecated. This method will be removed in the next major release.

Retrieves the password for an encyrpted private key on the current thread in an internal format.

Returns:

Password for private key

setSSLClientTrustManager

public final void setSSLClientTrustManager(TrustManager trustManager)

Customizes the trust manager on the current thread used for SSL certificate chain validation.

Parameters:

trustManager - Custom trust manager

getSSLClientTrustManager

public final TrustManager getSSLClientTrustManager()

Returns the custom trust manager on the current thread used for SSL certificate chain validation.

Returns:

Custom trust manager, null if no custom trust manager has been set.

setBoolean

public final void setBoolean(String name,
                             boolean value)

Sets the value of the specified property as a boolean.

Parameters:

name - Name of property to set

value - Value to be set as a boolean

getProperty

public final Object getProperty(String name)

Returns the value of the specified property. The order of lookup is to first look in environment hashtable, then in system properties, and to return null if not found.

Parameters:

name - Name of property to retrieve

Returns:

Property value as an object

getPropertyFromEnv

public final Object getPropertyFromEnv(String name)

setProperty

public final Object setProperty(String name,
                                Object value)

Sets the specified property.

Parameters:

name - Name of property to be set

value - Value (as object) to be set

removeProperty

public final Object removeProperty(String name)

Removes the specified property.

Parameters:

name - Name of property to remove

Returns:

Property that was removed as an object

getProviderIdentity

public final weblogic.protocol.ServerIdentity getProviderIdentity()
                                                           throws IllegalArgumentException

Deprecated. 

Gets the value of the PROVIDER_RJVM property, which is the RJVM associated with an Environment.

Returns:

ServerIdentity associated with an Environment

Throws:

IllegalArgumentException - if the context name is unavailable or invalid at runtime

See Also:

WLContext.PROVIDER_RJVM

setProviderIdentity

public final void setProviderIdentity(weblogic.protocol.ServerIdentity rjvm)

Deprecated. 

Sets PROVIDER_RJVM property associated with an Environment.

Parameters:

rjvm - ServerIdentity

See Also:

WLContext.PROVIDER_RJVM

setEnableDefaultUser

public void setEnableDefaultUser(boolean defaultUser)

getEnableDefaultUser

public boolean getEnableDefaultUser()

loadLocalIdentity

public final void loadLocalIdentity(Certificate[] certs,
                                    PrivateKey privateKey)

Loads the local identity onto the current thread given an array of certs and the private key.

Parameters:

certs - An array of certificates

privateKey - The private key

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException