Environment (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.jndi.Environment

All Implemented Interfaces:: java.io.Externalizable, java.io.Serializable, ServerEnvironment, ClientEnvironment

@Service
@PerLookup
public final class Environment
extends java.lang.Object
implements java.io.Externalizable, ServerEnvironment

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);

This code can be rewritten using an Environment object as illustrated here:

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

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String DEFAULT_INITIAL_CONTEXT_FACTORY

static java.lang.String LOCAL_URL_PROTOCOL

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`DEFAULT_INITIAL_CONTEXT_FACTORY`
`static java.lang.String`	`LOCAL_URL_PROTOCOL`

Constructor Summary

Constructors
Constructor	Description
`Environment()`	Constructs an Environment with default properties, that is, with a WebLogic initial context.
`Environment(java.util.Hashtable properties)`	Constructs an Environment and initializes it with the properties contained in the specified Hashtable.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`getBoolean(java.lang.String name, boolean defaultValue)`	Gets the value of the specified property as a boolean.
`java.lang.String`	`getClusterProviderUrl()`
`long`	`getConnectionTimeout()`	Get the request timeout value.
`javax.naming.Context`	`getContext()`	Returns a context that can be used with this environment.
`javax.naming.Context`	`getContext(java.lang.String contextName)`	Returns a subcontext of the initial context with the specified name.
`boolean`	`getCreateIntermediateContexts()`	Returns the value of the `WLContext.CREATE_INTERMEDIATE_CONTEXTS` property.
`java.util.Hashtable`	`getDelegateEnvironment()`	Returns the value of the `WLContext.DELEGATE_ENVIRONMENT` property.
`boolean`	`getEnableDefaultUser()`
`boolean`	`getEnableServerAffinity()`	Returns the value of the `WLContext.ENABLE_SERVER_AFFINITY` property.
`boolean`	`getForceResolveDNSName()`	Returns the value of the `Context.FORCE_RESOLVE_DNS_NAME` property.
`javax.naming.Context`	`getInitialContext()`	Returns an initial context based on the properties in an Environment.
`java.lang.String`	`getInitialContextFactory()`	Returns the value of `Context.INITIAL_CONTEXT_FACTORY`.
`boolean`	`getPinToPrimaryServer()`	Returns the value of the `WLContext.PIN_TO_PRIMARY_SERVER` property.
`java.util.Hashtable`	`getProperties()`	Returns the properties associated with an Environment as a Hashtable.
`java.lang.Object`	`getProperty(java.lang.String name)`	Returns the value of the specified property.
`java.lang.Object`	`getPropertyFromEnv(java.lang.String name)`
`java.lang.String`	`getProviderUrl()`	Returns the `Context.PROVIDER_URL` property value.
`boolean`	`getReplicateBindings()`	Returns the value of the `WLContext.REPLICATE_BINDINGS` property.
`long`	`getRequestTimeout()`	Deprecated. - Use setConnectionTimeout() instead
`long`	`getResponseReadTimeout()`	Get the request timeout value.
`long`	`getRMIClientTimeout()`	Deprecated. - Use getResponseReadTimeout instead.
`java.lang.Object`	`getSecurityCredentials()`	Returns the `Context.SECURITY_CREDENTIAL` property value.
`java.lang.String`	`getSecurityIdentityDomain()`	Returns the `WLContext.IDENTITY_DOMAIN` property value.
`java.lang.String`	`getSecurityPrincipal()`	Returns the value of the `Context.SECURITY_PRINCIPAL` property.
`java.lang.Object`	`getSSLClientCertificate()`	Returns an RSA private key and chain of X.509 certificates set for SSL client authentication on the current thread.
`java.lang.Object`	`getSSLClientKeyPassword()`	Deprecated. This method will be removed in the next major release.
`TrustManager`	`getSSLClientTrustManager()`	Returns the custom trust manager on the current thread used for SSL certificate chain validation.
`byte[][]`	`getSSLRootCAFingerprints()`	Returns the fingerprints of the certificates of trusted authorities associated with the current thread.
`java.lang.String`	`getSSLServerName()`	Gets the specified expected name from the current thread of the SSL server.
`java.lang.String`	`getString(java.lang.String name)`	Gets the value of the specified property as a String.
`void`	`loadLocalIdentity(java.security.cert.Certificate[] certs, java.security.PrivateKey privateKey)`	Loads the local identity onto the current thread given an array of certs and the private key.
`void`	`readExternal(java.io.ObjectInput in)`
`java.lang.Object`	`removeProperty(java.lang.String name)`	Removes the specified property.
`void`	`setBoolean(java.lang.String name, boolean value)`	Sets the value of the specified property as a boolean.
`void`	`setConnectionTimeout(long timeout)`	Set the request timeout value in milliseconds.
`void`	`setCreateIntermediateContexts(boolean flag)`	Set the `WLContext.CREATE_INTERMEDIATE_CONTEXTS` property to the String equivalent of the boolean argument flag.
`void`	`setDelegateEnvironment(java.util.Hashtable delegateEnv)`	Sets the `WLContext.DELEGATE_ENVIRONMENT` property to the value of the argument delegateEnv.
`void`	`setEnableDefaultUser(boolean defaultUser)`
`void`	`setEnableServerAffinity(boolean enable)`	Sets the `WLContext.ENABLE_SERVER_AFFINITY` property to the String equivalent of the boolean argument enable.
`void`	`setInitialContextFactory(java.lang.String factoryName)`	Sets the `Context.INITIAL_CONTEXT_FACTORY` property value to the value of factoryName.
`void`	`setPinToPrimaryServer(boolean enable)`	Sets the `WLContext.PIN_TO_PRIMARY_SERVER` property to the String equivalent of the boolean argument enable.
`java.lang.Object`	`setProperty(java.lang.String name, java.lang.Object value)`	Sets the specified property.
`void`	`setProviderUrl(java.lang.String url)`	Sets the `Context.PROVIDER_URL` property value to the value of the argument url.
`void`	`setProviderURL(java.lang.String url)`	Sets the Context.PROVIDER_URL property
`void`	`setReplicateBindings(boolean enable)`	Sets the `WLContext.REPLICATE_BINDINGS` property to the String equivalent of the boolean argument enable.
`void`	`setRequestTimeout(long timeout)`	Deprecated.
`void`	`setResponseReadTimeout(long timeout)`	Set the request timeout value.
`void`	`setRMIClientTimeout(long timeout)`	Deprecated. - Use setResponseReadTimeout() instead
`void`	`setSecurityCredentials(java.lang.Object password)`	Sets the value of the `Context.SECURITY_CREDENTIAL` property to the value of the argument password.
`void`	`setSecurityIdentityDomain(java.lang.String idd)`	Sets the value of the `WLContext.IDENTITY_DOMAIN` property to the value of the argument idd.
`void`	`setSecurityPrincipal(java.lang.String principal)`	Sets the `Context.SECURITY_PRINCIPAL` property to the value of the argument principal.
`void`	`setSSLClientCertificate(java.io.InputStream[] chain)`	Deprecated. As of 12.2.1.1.0, use `loadLocalIdentity(Certificate[], PrivateKey)`
`void`	`setSSLClientKeyPassword(java.lang.String pass)`	Deprecated. As of 12.2.1.1.0, see `loadLocalIdentity(Certificate[], PrivateKey)`
`void`	`setSSLClientTrustManager(TrustManager trustManager)`	Customizes the trust manager on the current thread used for SSL certificate chain validation.
`void`	`setSSLContext(javax.net.ssl.SSLContext sslctx)`	Accept SSLContext from client
`void`	`setSSLRootCAFingerprints(byte[][] fps)`	Establishes a set of trusted certificate authorities on the current thread.
`void`	`setSSLRootCAFingerprints(java.lang.String fps)`	Establishes a set of trusted certificate authorities on the current thread.
`void`	`setSSLServerName(java.lang.String name)`	Sets an expected name on the current thread for the SSL server.
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_INITIAL_CONTEXT_FACTORY
```
public static final java.lang.String DEFAULT_INITIAL_CONTEXT_FACTORY
```
    See Also:
    
    Constant Field Values
  - LOCAL_URL_PROTOCOL
```
public static final java.lang.String LOCAL_URL_PROTOCOL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - 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(java.util.Hashtable properties)
```
    Constructs an Environment and initializes it with the properties contained in the specified Hashtable.
    
    Parameters:
    
    properties - Hashtable containing initial properties
- Method Detail
  - getProperties
```
public java.util.Hashtable getProperties()
```
    Returns the properties associated with an Environment as a Hashtable.
    
    Specified by:
    
    getProperties in interface ClientEnvironment
    
    Returns:
    
    Hashtable
  - getInitialContext
```
public final javax.naming.Context getInitialContext()
                                             throws javax.naming.NamingException
```
    Returns an initial context based on the properties in an Environment.
    
    Specified by:
    
    getInitialContext in interface ServerEnvironment
    
    Returns:
    
    Initial context
    
    Throws:
    
    javax.naming.NamingException - if the initial context cannot be obtained
  - getContext
```
public final javax.naming.Context getContext()
                                      throws javax.naming.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:
    
    javax.naming.NamingException
  - getContext
```
public final javax.naming.Context getContext(java.lang.String contextName)
                                      throws javax.naming.NamingException
```
    Returns a subcontext of the initial context with the specified name.
    
    Parameters:
    
    contextName - of the context to retrieve
    
    Returns:
    
    Initial context
    
    Throws:
    
    javax.naming.NamingException - if the initial context cannot be obtained
  - getClusterProviderUrl
```
public final java.lang.String getClusterProviderUrl()
```
  - getInitialContextFactory
```
public java.lang.String getInitialContextFactory()
                                          throws java.lang.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:
    
    java.lang.IllegalArgumentException - if the context name is unavailable or invalid at runtime
    
    See Also:
    
    Context.INITIAL_CONTEXT_FACTORY
  - setInitialContextFactory
```
public final void setInitialContextFactory(java.lang.String factoryName)
```
    Sets the Context.INITIAL_CONTEXT_FACTORY property value to the value of factoryName.
    
    Specified by:
    
    setInitialContextFactory in interface ServerEnvironment
    
    Parameters:
    
    factoryName - Initial context factory name
    
    See Also:
    
    Context.INITIAL_CONTEXT_FACTORY
  - getProviderUrl
```
public final java.lang.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.
    
    Specified by:
    
    getProviderUrl in interface ServerEnvironment
    
    Returns:
    
    Provider URL
    
    See Also:
    
    Context.PROVIDER_URL
  - setProviderUrl
```
public final void setProviderUrl(java.lang.String url)
```
    Sets the Context.PROVIDER_URL property value to the value of the argument url.
    
    Specified by:
    
    setProviderUrl in interface ServerEnvironment
    
    Parameters:
    
    url - Provider url
    
    See Also:
    
    Context.PROVIDER_URL
  - setProviderURL
```
public final void setProviderURL(java.lang.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 java.util.Hashtable getDelegateEnvironment()
                                                 throws java.lang.IllegalArgumentException
```
    Returns the value of the WLContext.DELEGATE_ENVIRONMENT property.
    
    Returns:
    
    Hashtable of properties for delegate environment
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    WLContext.DELEGATE_ENVIRONMENT
  - setDelegateEnvironment
```
public final void setDelegateEnvironment(java.util.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
  - getForceResolveDNSName
```
public final boolean getForceResolveDNSName()
                                     throws java.lang.IllegalArgumentException
```
    Returns the value of the Context.FORCE_RESOLVE_DNS_NAME property. If unset, defaults to false.
    
    Returns:
    
    True if FORCE_RESOLVE_DNS_NAME is set
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    WLContext.FORCE_RESOLVE_DNS_NAME
  - getSecurityPrincipal
```
public final java.lang.String getSecurityPrincipal()
                                            throws java.lang.IllegalArgumentException
```
    Returns the value of the Context.SECURITY_PRINCIPAL property. If unset, defaults to guest.
    
    Returns:
    
    String (principal name)
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    Context.SECURITY_PRINCIPAL
  - setSecurityPrincipal
```
public final void setSecurityPrincipal(java.lang.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 java.lang.Object getSecurityCredentials()
                                              throws java.lang.IllegalArgumentException
```
    Returns the Context.SECURITY_CREDENTIAL property value.
    
    Returns:
    
    Password string, Certificate or UserInfo
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    Context.SECURITY_PRINCIPAL
  - setSecurityCredentials
```
public final void setSecurityCredentials(java.lang.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
  - getSecurityIdentityDomain
```
public final java.lang.String getSecurityIdentityDomain()
                                                 throws java.lang.IllegalArgumentException
```
    Returns the WLContext.IDENTITY_DOMAIN property value.
    
    Returns:
    
    Identity domain string
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    WLContext.IDENTITY_DOMAIN
  - setSecurityIdentityDomain
```
public final void setSecurityIdentityDomain(java.lang.String idd)
```
    Sets the value of the WLContext.IDENTITY_DOMAIN property to the value of the argument idd.
    
    Parameters:
    
    idd - Identity Domain (String)
    
    See Also:
    
    WLContext.IDENTITY_DOMAIN
  - getCreateIntermediateContexts
```
public final boolean getCreateIntermediateContexts()
                                            throws java.lang.IllegalArgumentException
```
    Returns the value of the WLContext.CREATE_INTERMEDIATE_CONTEXTS property.
    
    Returns:
    
    True if intermediate contexts are in use
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    WLContext.CREATE_INTERMEDIATE_CONTEXTS
  - setCreateIntermediateContexts
```
public final void setCreateIntermediateContexts(boolean flag)
                                         throws java.lang.IllegalArgumentException
```
    Set the WLContext.CREATE_INTERMEDIATE_CONTEXTS property to the String equivalent of the boolean argument flag.
    
    Specified by:
    
    setCreateIntermediateContexts in interface ServerEnvironment
    
    Parameters:
    
    flag - to turn on use of intermediate contexts
    
    Throws:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    WLContext.CREATE_INTERMEDIATE_CONTEXTS
  - getReplicateBindings
```
public final boolean getReplicateBindings()
                                   throws java.lang.IllegalArgumentException
```
    Returns the value of the WLContext.REPLICATE_BINDINGS property.
    
    Returns:
    
    True if replicated bindings are in use
    
    Throws:
    
    java.lang.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.
    
    Specified by:
    
    setReplicateBindings in interface ServerEnvironment
    
    Parameters:
    
    enable - True to enable replicated bindings
    
    See Also:
    
    WLContext.REPLICATE_BINDINGS
  - getPinToPrimaryServer
```
public final boolean getPinToPrimaryServer()
                                    throws java.lang.IllegalArgumentException
```
    Returns the value of the WLContext.PIN_TO_PRIMARY_SERVER property.
    
    Returns:
    
    True if context will only connect to the primary server.
    
    Throws:
    
    java.lang.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:
    
    java.lang.IllegalArgumentException - if the property is unavailable or invalid at runtime
    
    See Also:
    
    WLContext.ENABLE_SERVER_AFFINITY
  - setRequestTimeout
```
@Deprecated
public final void setRequestTimeout(long timeout)
```
    Deprecated.
    
    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
```
@Deprecated
public final long getRequestTimeout()
```
    Deprecated.
    - Use setConnectionTimeout() instead
    
    Get the request timeout value.
    
    Returns:
    
    timeout value in milliseconds
  - setConnectionTimeout
```
public final void setConnectionTimeout(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.
    
    Specified by:
    
    setConnectionTimeout in interface ClientEnvironment
    
    Parameters:
    
    timeout - value in milliseconds.
  - getConnectionTimeout
```
public final long getConnectionTimeout()
```
    Get the request timeout value.
    
    Returns:
    
    timeout value in milliseconds
  - setRMIClientTimeout
```
@Deprecated
public final void setRMIClientTimeout(long timeout)
```
    Deprecated.
    - Use setResponseReadTimeout() instead
    
    Parameters:
    
    timeout -
  - getRMIClientTimeout
```
@Deprecated
public final long getRMIClientTimeout()
```
    Deprecated.
    - Use getResponseReadTimeout instead.
    
    Get the request timeout value.
    
    Returns:
    
    timeout value in milliseconds
  - setResponseReadTimeout
```
public final void setResponseReadTimeout(long timeout)
```
    Description copied from interface: ClientEnvironment
    
    Set the request timeout value. JNDI request that fail to get a response within the timeout value will fail with RequestTimeoutException. A value of 0, default, implies the request will never timeout.
    
    Specified by:
    
    setResponseReadTimeout in interface ClientEnvironment
    
    Parameters:
    
    timeout - value in milliseconds
  - getResponseReadTimeout
```
public final long getResponseReadTimeout()
```
    Get the request timeout value.
    
    Returns:
    
    timeout value in milliseconds
  - getString
```
public final java.lang.String getString(java.lang.String name)
                                 throws java.lang.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:
    
    java.lang.IllegalArgumentException - if the property value is not a String
  - getBoolean
```
public final boolean getBoolean(java.lang.String name,
                                boolean defaultValue)
                         throws java.lang.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:
    
    java.lang.IllegalArgumentException - if the context name is unavailable or invalid at runtime
    
    java.lang.IllegalArgumentException - if the property value is not "true" or "false"
  - setSSLRootCAFingerprints
```
public final void setSSLRootCAFingerprints(java.lang.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(java.lang.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 java.lang.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 java.lang.Object getSSLClientCertificate()
                                               throws java.io.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:
    
    java.io.IOException
    
    See Also:
    
    PEMInputStream, BufferedInputStream
  - setSSLClientCertificate
```
@Deprecated
public final void setSSLClientCertificate(java.io.InputStream[] chain)
```
    Deprecated.
    As of 12.2.1.1.0, use loadLocalIdentity(Certificate[], PrivateKey)
    
    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
```
@Deprecated
public final void setSSLClientKeyPassword(java.lang.String pass)
```
    Deprecated.
    As of 12.2.1.1.0, see loadLocalIdentity(Certificate[], PrivateKey)
    
    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
```
@Deprecated
public final java.lang.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(java.lang.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 java.lang.Object getProperty(java.lang.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 java.lang.Object getPropertyFromEnv(java.lang.String name)
```
  - setProperty
```
public final java.lang.Object setProperty(java.lang.String name,
                                          java.lang.Object value)
```
    Sets the specified property.
    
    Specified by:
    
    setProperty in interface ServerEnvironment
    
    Parameters:
    
    name - Name of property to be set
    
    value - Value (as object) to be set
  - removeProperty
```
public final java.lang.Object removeProperty(java.lang.String name)
```
    Removes the specified property.
    
    Parameters:
    
    name - Name of property to remove
    
    Returns:
    
    Property that was removed as an object
  - setEnableDefaultUser
```
public void setEnableDefaultUser(boolean defaultUser)
```
    Specified by:
    
    setEnableDefaultUser in interface ServerEnvironment
  - getEnableDefaultUser
```
public boolean getEnableDefaultUser()
```
    Specified by:
    
    getEnableDefaultUser in interface ServerEnvironment
  - loadLocalIdentity
```
public final void loadLocalIdentity(java.security.cert.Certificate[] certs,
                                    java.security.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
  - setSSLContext
```
public final void setSSLContext(javax.net.ssl.SSLContext sslctx)
```
    Accept SSLContext from client
    
    Parameters:
    
    sslctx - SSLContext
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

Class Environment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INITIAL_CONTEXT_FACTORY

LOCAL_URL_PROTOCOL

Constructor Detail

Environment

Environment

Method Detail

getProperties

getInitialContext

getContext

getContext

getClusterProviderUrl

getInitialContextFactory

setInitialContextFactory

getProviderUrl

setProviderUrl

setProviderURL

getDelegateEnvironment

setDelegateEnvironment

getForceResolveDNSName

getSecurityPrincipal

setSecurityPrincipal

getSecurityCredentials

setSecurityCredentials

getSecurityIdentityDomain

setSecurityIdentityDomain

getCreateIntermediateContexts

setCreateIntermediateContexts

getReplicateBindings

setReplicateBindings

getPinToPrimaryServer

setPinToPrimaryServer

setEnableServerAffinity

getEnableServerAffinity

setRequestTimeout

getRequestTimeout

setConnectionTimeout

getConnectionTimeout

setRMIClientTimeout

getRMIClientTimeout

setResponseReadTimeout

getResponseReadTimeout

getString

getBoolean

setSSLRootCAFingerprints

setSSLRootCAFingerprints

getSSLRootCAFingerprints

setSSLServerName

getSSLServerName

getSSLClientCertificate

setSSLClientCertificate

setSSLClientKeyPassword

getSSLClientKeyPassword

setSSLClientTrustManager

getSSLClientTrustManager

setBoolean

getProperty

getPropertyFromEnv

setProperty

removeProperty

setEnableDefaultUser

getEnableDefaultUser

loadLocalIdentity

setSSLContext

writeExternal

readExternal