|
Oracle Fusion Middleware Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.6) Part Number E13945-06 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WTCLocalTuxDomMBean
This interface provides access to the WTC local Tuxedo Domain configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
This is a type-safe interface for a
WebLogic Server MBean, which you can import into your client
classes and access through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, client classes that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
String |
getAccessPoint()
The unique name used to identify this local Tuxedo access point. |
String |
getAccessPointId()
The connection principal name used to identify this local Tuxedo access point when attempting to establish a session connection with remote Tuxedo access points. |
long |
getBlockTime()
The maximum number of seconds this local Tuxedo access point allows for a blocking call. |
int |
getCmpLimit()
The compression threshold this local Tuxedo access point uses when sending data to a remote Tuxedo access point. |
String |
getConnectionPolicy()
The conditions under which this local Tuxedo access point establishes a session connection with a remote Tuxedo access point. |
String |
getConnPrincipalName()
The principal name used to verify the identity of this domain when establishing a connection to another domain. |
String |
getIdentityKeyStoreFileName()
The path and file name of the identity keystore. |
String |
getIdentityKeyStorePassPhrase()
The custom identity keystore's passphrase. |
byte[] |
getIdentityKeyStorePassPhraseEncrypted()
The identity keystore's encrypted passphrase. |
String |
getInteroperate()
Specifies whether this local Tuxedo access point interoperates with remote Tuxedo access points that are based upon Tuxedo release 6.5. |
int |
getKeepAlive()
Return value tells whether this local Tuxedo access point is configured with Application Level Keep Alive, and it maximum idle time value before wait timer start ticking. |
int |
getKeepAliveWait()
Return value that tells whether this local Tuxedo access point requires the acknowledgement of Application Level Keep Alive, and how long it will wait without receiving acknowledgement before declare the connection is inaccessible. |
String |
getKeyStoresLocation()
Provides the configuration rule to be used for finding Local Access Point's identity key store and trust key store. |
String |
getMaxEncryptBits()
The maximum encryption key length (in bits) this local Tuxedo access point uses when establishing a session connection. |
long |
getMaxRetries()
The maximum number of times that this local Tuxedo access point tries to establish a session connection to remote Tuxedo access points. |
String |
getMinEncryptBits()
The minimum encryption key length (in bits) this local Tuxedo access point uses when establishing a session connection. |
String |
getNWAddr()
The network address and port number of this local Tuxedo access point. |
String |
getPrivateKeyAlias()
The string alias used to store and retrieve the Local Tuxedo access point's private key in the keystore. |
String |
getPrivateKeyPassPhrase()
The passphrase used to retrieve the server's private key from the keystore. |
byte[] |
getPrivateKeyPassPhraseEncrypted()
The encrypted passphrase used to retrieve the Local Tuxedo access point's private key from the keystore. |
long |
getRetryInterval()
The number of seconds that this local Tuxedo access point waits between automatic connection attempts to remote Tuxedo access points. |
String |
getSecurity()
The type of application security enforced. |
String |
getTrustKeyStoreFileName()
The path and file name of the trust keystore. |
String |
getTrustKeyStorePassPhrase()
The trust keystore's passphrase. |
byte[] |
getTrustKeyStorePassPhraseEncrypted()
The trust keystore's encrypted passphrase. |
String |
getUseSSL()
Specifies if the connection initiated or accepted by this Local Tuxedo access point uses SSL on top of its transport layer. |
void |
setAccessPoint(String AccessPoint)
Sets the value of the AccessPoint attribute. |
void |
setAccessPointId(String AccessPointId)
Sets the value of the AccessPointId attribute. |
void |
setBlockTime(long BlockTime)
Sets the value of the BlockTime attribute. |
void |
setCmpLimit(int CmpLimit)
Sets the value of the CmpLimit attribute. |
void |
setConnectionPolicy(String ConnectionPolicy)
Sets the value of the ConnectionPolicy attribute. |
void |
setConnPrincipalName(String ConnPrincipalName)
Sets the value of the ConnPrincipalName attribute. |
void |
setIdentityKeyStoreFileName(String keystore)
Sets the value of the identityKeyStoreFileName attribute. |
void |
setIdentityKeyStorePassPhrase(String passPhrase)
Sets the value of the CustomIdentityKeyStorePassPhrase attribute. |
void |
setIdentityKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the IdentityKeyStorePassPhrase attribute. |
void |
setInteroperate(String Interoperate)
Sets the value of the Interoperate attribute. |
void |
setKeepAlive(int KeepAlive)
Sets the value of the KeepAlive attribute. |
void |
setKeepAliveWait(int KeepAliveWait)
Sets the value of the KeepAliveWait attribute. |
void |
setKeyStoresLocation(String location)
Sets the value of the KeyStoresLocation attribute. |
void |
setMaxEncryptBits(String MaxEncryptBits)
Sets the value of the MaxEncryptBits attribute. |
void |
setMaxRetries(long MaxRetries)
Sets the value of the MaxRetries attribute. |
void |
setMinEncryptBits(String MinEncryptBits)
Sets the value of the MinEncryptBits attribute. |
void |
setNWAddr(String ListenAddress)
Sets the value of the NWAddr attribute. |
void |
setPrivateKeyAlias(String alias)
Sets the value of the PrivateKeyAlias attribute. |
void |
setPrivateKeyPassPhrase(String passPhrase)
Sets the value of the PrivateKeyPassPhrase attribute. |
void |
setPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)
Sets the value of the privateKeyPassPhrase attribute. |
void |
setRetryInterval(long RetryInterval)
Sets the value of the RetryInterval attribute. |
void |
setSecurity(String Security)
Sets the value of the Security attribute. |
void |
setTrustKeyStoreFileName(String keystore)
Sets the value of the TrustKeyStoreFilename attribute. |
void |
setTrustKeyStorePassPhrase(String passPhrase)
Sets the value of the TrustKeyStorePassPhrase attribute. |
void |
setTrustKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the TrustKeyStorePassPhrase attribute. |
void |
setUseSSL(String useSSL)
|
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Method Detail |
---|
void setAccessPoint(String AccessPoint) throws InvalidAttributeValueException
Sets the value of the AccessPoint attribute.
AccessPoint
- the name for the local Tuxedo access point
InvalidAttributeValueException
WTCLocalTuxDomMBean.getAccessPoint()
String getAccessPoint()
The unique name used to identify this local Tuxedo access point. This name should be unique for all local and remote Tuxedo access points defined within a WTC Service. This allows you to define unique configurations having the same Access Point ID.
void setAccessPointId(String AccessPointId) throws InvalidAttributeValueException
Sets the value of the AccessPointId attribute.
AccessPointId
- the local Tuxedo access point identifier
InvalidAttributeValueException
WTCLocalTuxDomMBean.getAccessPointId()
String getAccessPointId()
The connection principal name used to identify this local Tuxedo access point when attempting to establish a session connection with remote Tuxedo access points.
Note: The AccessPointId must match the corresponding DOMAINID in the *DM_REMOTE_DOMAINS section of your Tuxedo DMCONFIG file.
void setSecurity(String Security) throws InvalidAttributeValueException
Sets the value of the Security attribute.
Security
- the security level to be enforced
InvalidAttributeValueException
WTCLocalTuxDomMBean.getSecurity()
String getSecurity()
The type of application security enforced.
The types of security are:
void setConnectionPolicy(String ConnectionPolicy) throws InvalidAttributeValueException
Sets the value of the ConnectionPolicy attribute.
ConnectionPolicy
- the connection policy for this local Tuxedo access point
InvalidAttributeValueException
#getConectionPolicy
String getConnectionPolicy()
The conditions under which this local Tuxedo access point establishes a session connection with a remote Tuxedo access point.
The connection policies are:
void setConnPrincipalName(String ConnPrincipalName) throws InvalidAttributeValueException
Sets the value of the ConnPrincipalName attribute.
ConnPrincipalName
- The new connPrincipalName value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getConnPrincipalName()
String getConnPrincipalName()
The principal name used to verify the identity of this domain when establishing a connection to another domain.
Note: This parameter only applies to domains of type
TDOMAIN that are running Oracle Tuxedo 7.1 or later software. If not
specified, the connection principal name defaults to the
AccessPointID for this domain.ConnPrincipalName
.
Note: ConnPrincipalName is not supported in this release.
void setRetryInterval(long RetryInterval) throws InvalidAttributeValueException
Sets the value of the RetryInterval attribute.
RetryInterval
- the retry interval for this local Tuxedo access point
InvalidAttributeValueException
WTCLocalTuxDomMBean.getRetryInterval()
long getRetryInterval()
The number of seconds that this local Tuxedo access point waits
between automatic connection attempts to remote Tuxedo access
points. Use this value only when Connection Policy is set to
ON_STARTUP
.
Range of Values: Between 0 and a positive 32-bit integer.
void setMaxRetries(long MaxRetries) throws InvalidAttributeValueException
Sets the value of the MaxRetries attribute.
MaxRetries
- the number of times to attempt connection to remote Tuxedo access points
InvalidAttributeValueException
WTCLocalTuxDomMBean.getMaxRetries()
long getMaxRetries()
The maximum number of times that this local Tuxedo access point
tries to establish a session connection to remote Tuxedo access
points. Use this value only when Connection Policy is set to
ON_STARTUP
.
Range of Values: Between 0
and a positive
64 bit integer.
Note: Use the minimum value to disable the retry mechanism. Use the maximum value to try until a connection is established.
void setBlockTime(long BlockTime) throws InvalidAttributeValueException
Sets the value of the BlockTime attribute.
BlockTime
- the maximum wait time allowed for a blocking call
InvalidAttributeValueException
WTCLocalTuxDomMBean.getBlockTime()
long getBlockTime()
The maximum number of seconds this local Tuxedo access point allows for a blocking call.
Range of Values: Between 0
and a positive 32 bit
integer.
void setNWAddr(String ListenAddress) throws InvalidAttributeValueException
Sets the value of the NWAddr attribute.
ListenAddress
- The new nWAddr value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getNWAddr()
String getNWAddr()
The network address and port number of this local Tuxedo access point.
Specify the address in one of the following formats://hostname:port_number
or
//#.#.#.#:port_number
.sdp://hostname:port_number
or
sdp://#.#.#.#:port_number
.
void setCmpLimit(int CmpLimit) throws InvalidAttributeValueException
Sets the value of the CmpLimit attribute.
CmpLimit
- The compression threshold for this local Tuxedo access point
InvalidAttributeValueException
#getCmplimit
int getCmpLimit()
The compression threshold this local Tuxedo access point uses when sending data to a remote Tuxedo access point. Application buffers larger than this size are compressed.
Range of Values: Between 0
and a positive 32-bit
integer.
void setMinEncryptBits(String MinEncryptBits) throws InvalidAttributeValueException
Sets the value of the MinEncryptBits attribute.
MinEncryptBits
- The minimum encryption level desired for this local Tuxedo access point
InvalidAttributeValueException
WTCLocalTuxDomMBean.getMinEncryptBits()
String getMinEncryptBits()
The minimum encryption key length (in bits) this local Tuxedo
access point uses when establishing a session connection. A value
of 0
indicates no encryption is used.
Value Restrictions:
40
can be used only with
domains running Tuxedo 7.1 or higher.
void setMaxEncryptBits(String MaxEncryptBits) throws InvalidAttributeValueException
Sets the value of the MaxEncryptBits attribute.
MaxEncryptBits
- The encryption level desired for this local Tuxedo access point
InvalidAttributeValueException
WTCLocalTuxDomMBean.getMaxEncryptBits()
String getMaxEncryptBits()
The maximum encryption key length (in bits) this local Tuxedo
access point uses when establishing a session connection. A value
of 0
indicates no encryption is used.
Value Restrictions:
40
can be used only with domains
running Tuxedo 7.1 or higher.
void setInteroperate(String Interoperate) throws InvalidAttributeValueException
Sets the value of the Interoperate attribute.
Interoperate
- The interoperatibility desired for this local Tuxedo access point
InvalidAttributeValueException
WTCLocalTuxDomMBean.getInteroperate()
String getInteroperate()
Specifies whether this local Tuxedo access point interoperates
with remote Tuxedo access points that are based upon Tuxedo release
6.5. If this value is set to Yes
, the local Tuxedo access
point interoperates with a Tuxedo 6.5 domain.
void setKeepAlive(int KeepAlive) throws InvalidAttributeValueException
Sets the value of the KeepAlive attribute. The value of 0 means no Application Level KeepAlive. Any other values in the valid value range means the maximum inactive time before start counting the the wait timer. The value is measured in millisecond and rounded up to second.
Keepalive
- The Application Level KeepAlive value.
InvalidAttributeValueException
WTCLocalTuxDomMBean.getKeepAlive()
int getKeepAlive()
Return value tells whether this local Tuxedo access point is configured with Application Level Keep Alive, and it maximum idle time value before wait timer start ticking.
void setKeepAliveWait(int KeepAliveWait) throws InvalidAttributeValueException
Sets the value of the KeepAliveWait attribute. The value of 0 means don't initiate Application Level KeepAlive, but do acknowledge if receive one. Any other values in the valid value range means the maximum time allowed without receiving acknowledgement before WTC declares the connection is inaccessible. The value is measured in millisecond and rounded up to second.
KeepaliveWait
- The Application Level KeepAliveWait value.
InvalidAttributeValueException
WTCLocalTuxDomMBean.getKeepAliveWait()
int getKeepAliveWait()
Return value that tells whether this local Tuxedo access point requires the acknowledgement of Application Level Keep Alive, and how long it will wait without receiving acknowledgement before declare the connection is inaccessible.
String getUseSSL()
Specifies if the connection initiated or accepted by this Local Tuxedo access point uses SSL on top of its transport layer. Values are:
Note: If SDP transport is configured for this access point,
the configured value of this attribute is ignored and off
is used.
void setUseSSL(String useSSL) throws InvalidAttributeValueException
useSSL
- The new useSSL value for this Local Tuxedo access point
InvalidAttributeValueException
String getKeyStoresLocation()
Provides the configuration rule to be used for
finding Local Access Point's identity key store and trust key store.
In plain text, it contains information on where the identity key store
and trust key store are configured. When KeyStoreLocation is configured
with WLS Store
, WTC uses configuration information from the WLS
Key Stores configuration. Otherwise, it uses the key stores
information configured in the Local Access Point.
void setKeyStoresLocation(String location) throws InvalidAttributeValueException
Sets the value of the KeyStoresLocation attribute.
location
- The new keyStoresLocation value
InvalidAttributeValueException
#getKeyStoreLocation()
String getIdentityKeyStoreFileName()
The path and file name of the identity keystore.
The path name must either be absolute or relative to where the server was booted. The identity key store file name is only used if KeystoreLocation is "Custom Stores".
void setIdentityKeyStoreFileName(String keystore) throws InvalidAttributeValueException
Sets the value of the identityKeyStoreFileName attribute.
fileName
- The new identityKeyStoreFileName value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getIdentityKeyStoreFileName()
String getIdentityKeyStorePassPhrase()
The custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is "Custom Stores".
When you get the value of this attribute, WebLogic Server does the following:
IdentityKeyStorePassPhraseEncrypted
attribute.
When you set the value of this attribute, WebLogic Server does the following:
CustomIdentityKeyStorePassPhraseEncrypted
attribute to the
encrypted value.Using this attribute (CustomIdentityKeyStorePassPhrase
) is a potential security risk because
the String object (which contains the unencrypted password) remains in
the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how
memory is allocated in the JVM, a significant amount of time could pass
before this unencrypted data is removed from memory.
Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted
.
#getCustomIdentityKeyStorePassPhraseEncrypted()
void setIdentityKeyStorePassPhrase(String passPhrase) throws InvalidAttributeValueException
Sets the value of the CustomIdentityKeyStorePassPhrase attribute.
passPhrase
- The new customIdentityKeyStorePassPhrase value
InvalidAttributeValueException
#getCustomIdentityKeyStorePassPhrase()
,
#setCustomIdentityKeyStorePassPhraseEncrypted(byte[])
byte[] getIdentityKeyStorePassPhraseEncrypted()
The identity keystore's encrypted passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is "Custom Stores".
To set this attribute, use weblogic.management.EncryptionHelper.encrypt()
to encrypt the value. Then set this attribute to the output of the encrypt() method.
To compare a password that a user enters with the encrypted
value of this attribute, use the same WebLogic Server instance
that you used to set and encrypt this attribute
and use weblogic.management.EncryptionHelper.encrypt()
to encrypt the user-supplied password. Then compare the encrypted values.
void setIdentityKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the IdentityKeyStorePassPhrase attribute.
passPhraseEncrypted
- The new encrypted identityKeyStorePassPhrase valueWTCLocalTuxDomMBean.getIdentityKeyStorePassPhraseEncrypted()
String getPrivateKeyAlias()
The string alias used to store and retrieve the Local Tuxedo access point's private key in the keystore. This private key is associated with the Local Tuxedo access point's digital certificate.
void setPrivateKeyAlias(String alias) throws InvalidAttributeValueException
Sets the value of the PrivateKeyAlias attribute.
alias
- The new privateKeyAlias value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getPrivateKeyAlias()
String getPrivateKeyPassPhrase()
The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated.
When you get the value of this attribute, WebLogic Server does the following:
PrivateKeyPassPhraseEncrypted
attribute.
When you set the value of this attribute, WebLogic Server does the following:
PrivateKeyPassPhraseEncrypted
attribute to the
encrypted value.Using this attribute (PrivateKeyPassPhrase
) is a potential
security risk because
the String object (which contains the unencrypted passphrase) remains in
the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how
memory is allocated in the JVM, a significant amount of time could pass
before this unencrypted data is removed from memory.
Instead of using this attribute, use
getPrivateKeyPassPhraseEncrypted
.
void setPrivateKeyPassPhrase(String passPhrase) throws InvalidAttributeValueException
Sets the value of the PrivateKeyPassPhrase attribute.
phrase
- The new privateKeyPassPhrase value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getPrivateKeyPassPhrase()
,
WTCLocalTuxDomMBean.setPrivateKeyPassPhraseEncrypted(byte[])
byte[] getPrivateKeyPassPhraseEncrypted()
The encrypted passphrase used to retrieve the Local Tuxedo access point's private key from the keystore. This passphrase is assigned to the private key when it is generated.
To set this attribute, use weblogic.management.EncryptionHelper.encrypt()
to encrypt the value. Then set this attribute to the output of the encrypt() method.
To compare a password that a user enters with the encrypted
value of this attribute, go to the same WebLogic Server instance
that you used to set and encrypt this attribute
and use weblogic.management.EncryptionHelper.encrypt()
to encrypt the user-supplied password. Then compare the encrypted values.
void setPrivateKeyPassPhraseEncrypted(byte[] phraseEncrypted)
Sets the value of the privateKeyPassPhrase attribute.
phraseEncrypted
- The new encrypted serverPrivateKeyPassPhrase value#setPrivateKeyPassPhraseEncrypted()
String getTrustKeyStoreFileName()
The path and file name of the trust keystore.
The path name must either be absolute or relative to where the server was booted. This file name is only used if KeyStores is "Custom Stores".
void setTrustKeyStoreFileName(String keystore) throws InvalidAttributeValueException
Sets the value of the TrustKeyStoreFilename attribute.
fileName
- The new trustKeyStoreFileName value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getTrustKeyStoreFileName()
String getTrustKeyStorePassPhrase()
The trust keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is "Custom Stores".
When you get the value of this attribute, WebLogic Server does the following:
TrustKeyStorePassPhraseEncrypted
attribute.
When you set the value of this attribute, WebLogic Server does the following:
TrustKeyStorePassPhraseEncrypted
attribute to the
encrypted value.Using this attribute (TrustKeyStorePassPhrase
) is a potential security risk because
the String object (which contains the unencrypted password) remains in
the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how
memory is allocated in the JVM, a significant amount of time could pass
before this unencrypted data is removed from memory.
Instead of using this attribute, use TrustKeyStorePassPhraseEncrypted
.
WTCLocalTuxDomMBean.getTrustKeyStorePassPhraseEncrypted()
void setTrustKeyStorePassPhrase(String passPhrase) throws InvalidAttributeValueException
Sets the value of the TrustKeyStorePassPhrase attribute.
passPhrase
- The new trustKeyStorePassPhrase value
InvalidAttributeValueException
WTCLocalTuxDomMBean.getTrustKeyStorePassPhrase()
,
WTCLocalTuxDomMBean.setTrustKeyStorePassPhraseEncrypted(byte[])
byte[] getTrustKeyStorePassPhraseEncrypted()
The trust keystore's encrypted passphrase. If empty or null, then the keystore will be opened without a passphrase.
This attribute is only used if KeyStores is "Custom Stores".
To set this attribute, use weblogic.management.EncryptionHelper.encrypt()
to encrypt the value. Then set this attribute to the output of the encrypt() method.
To compare a password that a user enters with the encrypted
value of this attribute, use the same WebLogic Server instance
that you used to set and encrypt this attribute
and use weblogic.management.EncryptionHelper.encrypt()
to encrypt the user-supplied password. Then compare the encrypted values.
void setTrustKeyStorePassPhraseEncrypted(byte[] passPhraseEncrypted)
Sets the encrypted value of the TrustKeyStorePassPhrase attribute.
passPhraseEncrypted
- The new encrypted trustKeyStorePassPhrase valueWTCLocalTuxDomMBean.getTrustKeyStorePassPhraseEncrypted()
|
Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Oracle WebLogic Server MBean Javadoc 11g Release 1 (10.3.6) Part Number E13945-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |