ConfigurationMBean
, DescriptorBean
, javax.management.DynamicMBean
, javax.management.MBeanRegistration
, javax.management.NotificationBroadcaster
, SettableBean
, WebLogicMBean
public interface WTCRemoteTuxDomMBean extends ConfigurationMBean
This interface provides access to the WTC remote Tuxedo Domain configuration attributes. The methods defined herein are applicable for WTC configuration at the WLS domain level.
DEFAULT_EMPTY_BYTE_ARRAY
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getAccessPoint() |
The unique name used to identify this remote Tuxedo access
point.
|
java.lang.String |
getAccessPointId() |
The connection principal name used to identify this remote
domain access point when attempting to establish a session
connection to local Tuxedo access points.
|
java.lang.String |
getAclPolicy() |
The inbound access control list (ACL) policy toward requests
from a remote Tuxedo access point.
|
boolean |
getAllowAnonymous() |
Specifies whether the anonymous user is allowed to access remote
Tuxedo services.
|
java.lang.String |
getAppKey() |
Specifies the type of AppKey plug-in used.
|
int |
getCmpLimit() |
The compression threshold this remote Tuxedo access point uses
when sending data to a local Tuxedo access point.
|
java.lang.String |
getConnectionPolicy() |
The conditions under which this remote Tuxedo access point
establishes a session connection with a local Tuxedo access
point.
|
java.lang.String |
getConnPrincipalName() |
The principal name used to verify the identity of this remote
Tuxedo access point when it establishes a session connection with a
local Tuxedo access point.
|
java.lang.String |
getCredentialPolicy() |
The outbound access control list (ACL) policy toward requests to
a remote Tuxedo access point.
|
java.lang.String |
getCustomAppKeyClass() |
The full pathname to the custom
AppKey generator class. |
java.lang.String |
getCustomAppKeyClassParam() |
The optional parameters to be used by the custom
AppKey
class at the class initialization time. |
int |
getDefaultAppKey() |
The default
AppKey value to be used by the anonymous
user and other users who are not defined in the user database if
the plug-in allows them to access Tuxedo. |
java.lang.String |
getFederationName() |
The context at which this remote Tuxedo access point federates
to a foreign name service.
|
java.lang.String |
getFederationURL() |
The URL for a foreign name service that is federated into
JNDI.
|
int |
getKeepAlive() |
Indicates whether this remote Tuxedo access point
is configured with Application Level Keep Alive.
|
int |
getKeepAliveWait() |
Indicates whether this remote Tuxedo access point
requires the acknowledgement of Application Level Keep Alive.
|
java.lang.String |
getLocalAccessPoint() |
The local domain name from which this remote Tuxedo domain is
reached.
|
java.lang.String |
getMaxEncryptBits() |
The maximum encryption key length (in bits) this remote Tuxedo
access point uses when establishing a session connection.
|
long |
getMaxRetries() |
The maximum number of times that this remote Tuxedo access point
tries to establish a session connections to local Tuxedo access
points.
|
java.lang.String |
getMinEncryptBits() |
The minimum encryption key length (in bits) this remote Tuxedo
access point uses when establishing a session connection.
|
java.lang.String |
getNWAddr() |
The network address and port number of this remote Tuxedo access
point.
|
long |
getRetryInterval() |
The number of seconds that this remote Tuxedo access point waits
between automatic connection attempts to local Tuxedo access
points.
|
java.lang.String |
getSSLProtocolVersion() |
The protocol version of the SSL connection this remote access point uses
when establishing a SSL connection with specific local access point.
|
java.lang.String |
getTpUsrFile() |
The full path to the user password file containing UID/GID
information.
|
java.lang.String |
getTuxedoGidKw() |
The keyword for Tuxedo GID (Group ID) used in the
WlsUser when using the Tuxedo migration utility
tpmigldap . |
java.lang.String |
getTuxedoUidKw() |
The keyword for Tuxedo UID (User ID) used in the
WlsUser when using the Tuxedo migration utility
tpmigldap . |
void |
setAccessPoint(java.lang.String AccessPoint) |
Sets the value of the AccessPoint attribute.
|
void |
setAccessPointId(java.lang.String AccessPointId) |
Sets the value of the AccessPointId attribute.
|
void |
setAclPolicy(java.lang.String AclPolicy) |
Sets the value of the AclPolicy attribute.
|
void |
setAllowAnonymous(boolean AllowAnonymous) |
Sets the value of the AllowAnonymous attribute.
|
void |
setAppKey(java.lang.String AppKey) |
Sets the value of the AppKey attribute.
|
void |
setCmpLimit(int CmpLimit) |
Sets the value of the CmpLimit attribute.
|
void |
setConnectionPolicy(java.lang.String ConnectionPolicy) |
Sets the value of the ConnectionPolicy attribute.
|
void |
setConnPrincipalName(java.lang.String ConnPrincipalName) |
Sets the value of the ConnPrincipalName attribute.
|
void |
setCredentialPolicy(java.lang.String CredentialPolicy) |
Sets the value of the CredentialPolicy attribute.
|
void |
setCustomAppKeyClass(java.lang.String AppKeyClass) |
Sets the value of the CustomAppKeyClass attribute.
|
void |
setCustomAppKeyClassParam(java.lang.String Param) |
Sets the value of the CustomAppKeyClassParam attribute.
|
void |
setDefaultAppKey(int DfltAppKey) |
Sets the value of the DefaultAppKey attribute.
|
void |
setFederationName(java.lang.String FederationName) |
Sets the value of the FederationName attribute.
|
void |
setFederationURL(java.lang.String FederationURL) |
Sets the value of the FederationURL attribute.
|
void |
setKeepAlive(int KeepAlive) |
Sets the value of the KeepAlive attribute.
|
void |
setKeepAliveWait(int KeepAliveWait) |
Sets the value of the KeepAliveWait attribute.
|
void |
setLocalAccessPoint(java.lang.String LocalAccessPoint) |
Sets the value of the LocalAccessPoint attribute.
|
void |
setMaxEncryptBits(java.lang.String MaxEncryptBits) |
Sets the value of the MaxEncryptBits attribute.
|
void |
setMaxRetries(long MaxRetries) |
Sets the value of the MaxRetries attribute.
|
void |
setMinEncryptBits(java.lang.String MinEncryptBits) |
Sets the value of the MinEncryptBits attribute.
|
void |
setNWAddr(java.lang.String ListenAddress) |
Sets the value of the NWAddr attribute.
|
void |
setRetryInterval(long RetryInterval) |
Sets the value of the RetryInterval attribute.
|
void |
setSSLProtocolVersion(java.lang.String SSLProtocolVersion) |
Sets the value of the SSLProtocolVersion attribute.
|
void |
setTpUsrFile(java.lang.String TpUsrFile) |
Sets the value of the TpUsrFile attribute.
|
void |
setTuxedoGidKw(java.lang.String GidKw) |
Sets the value of the TuxedoGidKw attribute.
|
void |
setTuxedoUidKw(java.lang.String UidKw) |
Sets the value of the TuxedoUidKw attribute.
|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
void setAccessPoint(java.lang.String AccessPoint) throws javax.management.InvalidAttributeValueException
Sets the value of the AccessPoint attribute. This name should be unique for all local and remote Tuxedo access points defined within a WTC Service.
AccessPoint
- the name for the remote domain access pointjavax.management.InvalidAttributeValueException
getAccessPoint()
java.lang.String getAccessPoint()
The unique name used to identify this remote 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(java.lang.String AccessPointId) throws javax.management.InvalidAttributeValueException
Sets the value of the AccessPointId attribute. This value must be globally unique among all interconnected Tuxedo and WTC Domains.
AccessPointId
- the remote domain access point identifierjavax.management.InvalidAttributeValueException
getAccessPointId()
java.lang.String getAccessPointId()
The connection principal name used to identify this remote domain access point when attempting to establish a session connection to local Tuxedo access points. This value must be globally unique among all interconnected Tuxedo and WTC Domains.
void setConnectionPolicy(java.lang.String ConnectionPolicy) throws javax.management.InvalidAttributeValueException
Sets the value of the ConnectionPolicy attribute.
ConnectionPolicy
- the connection policy for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getConnectionPolicy()
java.lang.String getConnectionPolicy()
The conditions under which this remote Tuxedo access point establishes a session connection with a local Tuxedo access point.
The allowed values are:
void setAclPolicy(java.lang.String AclPolicy) throws javax.management.InvalidAttributeValueException
Sets the value of the AclPolicy attribute.
AclPolicy
- the AclPolicy for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getAclPolicy()
java.lang.String getAclPolicy()
The inbound access control list (ACL) policy toward requests from a remote Tuxedo access point.
The allowed values are:
Note: If Interoperate is set to Yes, AclPolicy is ignored.
void setCredentialPolicy(java.lang.String CredentialPolicy) throws javax.management.InvalidAttributeValueException
Sets the value of the CredentialPolicy attribute.
CredentialPolicy
- the CredentialPolicy for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getCredentialPolicy()
java.lang.String getCredentialPolicy()
The outbound access control list (ACL) policy toward requests to a remote Tuxedo access point.
The allowed values are:
Note:If Interoperate is set to Yes, CredentialPolicy is ignored.
void setTpUsrFile(java.lang.String TpUsrFile) throws javax.management.InvalidAttributeValueException
Sets the value of the TpUsrFile attribute.
TpUsrFile
- the TpUsrFile URL for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getTpUsrFile()
java.lang.String getTpUsrFile()
The full path to the user password file containing UID/GID
information. (This field is only relevant if you specify
TpUsrFile
as the AppKey Generator.)
Note: This file is generated by the Tuxedo
tpusradd
utility on the remote Tuxedo domain specified
by the remote Tuxedo access point. A copy of this file must be
available in your WebLogic Tuxedo Connector environment to provide
correct authorization, authentication, and auditing.
void setLocalAccessPoint(java.lang.String LocalAccessPoint) throws javax.management.InvalidAttributeValueException
Sets the value of the LocalAccessPoint attribute.
LocalAccessPoint
- the name for the local Tuxedo access pointjavax.management.InvalidAttributeValueException
getLocalAccessPoint()
java.lang.String getLocalAccessPoint()
The local domain name from which this remote Tuxedo domain is reached.
void setConnPrincipalName(java.lang.String ConnPrincipalName) throws javax.management.InvalidAttributeValueException
Sets the value of the ConnPrincipalName attribute.
ConnPrincipalName
- The new connPrincipalName valuejavax.management.InvalidAttributeValueException
getConnPrincipalName()
java.lang.String getConnPrincipalName()
The principal name used to verify the identity of this remote Tuxedo access point when it establishes a session connection with a local Tuxedo access point. If not specified, the connection principal name defaults to the AccessPointID for this access point.
Note: This parameter only applies to domains of type TDOMAIN that are running Oracle Tuxedo 7.1 or later software.
Note: ConnPrincipalName is not supported in this release.
void setRetryInterval(long RetryInterval) throws javax.management.InvalidAttributeValueException
Sets the value of the RetryInterval attribute.
RetryInterval
- the retry interval for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getRetryInterval()
long getRetryInterval()
The number of seconds that this remote Tuxedo access point waits
between automatic connection attempts to local Tuxedo access
points. Use this only when the ConnectionPolicy value is set to
ON_STARTUP
.
Range of Values: Between -1
and a positive
32-bit integer.
Note: When the ConnectionPolicy value is LOCAL
,
the RetryInterval value from the local Tuxedo access point is used.
When the ConnectionPolicy value is ON_STARTUP
,
a value of -1
indicates 60.
void setMaxRetries(long MaxRetries) throws javax.management.InvalidAttributeValueException
Sets the value of the MaxRetries attribute.
MaxRetries
- the number of times to attempt connection to local Tuxedo access pointsjavax.management.InvalidAttributeValueException
getMaxRetries()
long getMaxRetries()
The maximum number of times that this remote Tuxedo access point
tries to establish a session connections to local Tuxedo access
points. Use only when the ConnectionPolicy value is set to
ON_STARTUP
.
Note: When the ConnectionPolicy value is LOCAL
,
the MaxRetries value from the local Tuxedo access point is used.
When the ConnectionPolicy value is ON_STARTUP
,
a value of -1
indicates 9223372036854775807.
Range of Values: Between -1
and a positive
64-bit integer.
0
to disable the retry mechanism.void setNWAddr(java.lang.String ListenAddress) throws javax.management.InvalidAttributeValueException
Sets the value of the NWAddr attribute.
ListenAddress
- The new nWAddr valuejavax.management.InvalidAttributeValueException
getNWAddr()
java.lang.String getNWAddr()
The network address and port number of this remote 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 setFederationURL(java.lang.String FederationURL) throws javax.management.InvalidAttributeValueException
Sets the value of the FederationURL attribute.
FederationURL
- url for a foreign name service federated into JNDIjavax.management.InvalidAttributeValueException
getFederationURL()
java.lang.String getFederationURL()
The URL for a foreign name service that is federated into JNDI.
Note: The Weblogic Tuxedo Connector can federate to non-CORBA service providers.
Note: If this value is not specified, the WebLogic Tuxedo Connector:
void setFederationName(java.lang.String FederationName) throws javax.management.InvalidAttributeValueException
Sets the value of the FederationName attribute.
FederationName
- context at which to federate to foreign name servicejavax.management.InvalidAttributeValueException
getFederationName()
java.lang.String getFederationName()
The context at which this remote Tuxedo access point federates
to a foreign name service. If omitted, the default federation point
is tuxedo.domains
.
void setCmpLimit(int CmpLimit) throws javax.management.InvalidAttributeValueException
Sets the value of the CmpLimit attribute.
CmpLimit
- The compression threshold for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getCmpLimit()
int getCmpLimit()
The compression threshold this remote Tuxedo access point uses when sending data to a local Tuxedo access point. Application buffers larger than this size are compressed.
Range of Values: Between 0
and a positive 32-bit
integer.
void setMinEncryptBits(java.lang.String MinEncryptBits) throws javax.management.InvalidAttributeValueException
Sets the value of the MinEncryptBits attribute.
MinEncryptBits
- The minimum encryption level desired for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getMinEncryptBits()
java.lang.String getMinEncryptBits()
The minimum encryption key length (in bits) this remote Tuxedo
access point uses when establishing a session connection. A value
of 0
indicates no encryption is used.
Value Restrictions:
void setMaxEncryptBits(java.lang.String MaxEncryptBits) throws javax.management.InvalidAttributeValueException
Sets the value of the MaxEncryptBits attribute.
MaxEncryptBits
- The maximum encryption level desired for this remote Tuxedo domainjavax.management.InvalidAttributeValueException
getMaxEncryptBits()
java.lang.String getMaxEncryptBits()
The maximum encryption key length (in bits) this remote Tuxedo
access point uses when establishing a session connection. A value
of 0
indicates no encryption is used.
Value Restrictions:
void setSSLProtocolVersion(java.lang.String SSLProtocolVersion) throws javax.management.InvalidAttributeValueException
Sets the value of the SSLProtocolVersion attribute.
SSLProtocolVersion
- The protocol version of the SSL connection for this remote Tuxedo access pointjavax.management.InvalidAttributeValueException
getSSLProtocolVersion()
java.lang.String getSSLProtocolVersion()
The protocol version of the SSL connection this remote access point uses when establishing a SSL connection with specific local access point.
Value Restrictions:
void setAppKey(java.lang.String AppKey) throws javax.management.InvalidAttributeValueException
Sets the value of the AppKey attribute.
AppKey
- The type of appkey generator plug-in selected.javax.management.InvalidAttributeValueException
getAppKey()
java.lang.String getAppKey()
Specifies the type of AppKey plug-in used.
The allowed values are:
TpUsrFile
is the default plug-in. It uses
an imported Tuxedo TPUSR file to provide user security information.
Previous releases of WebLogic Tuxedo Connector support this
option.LDAP
plug-in utilizes an embedded LDAP server
to provide user security information. The user record must define
the Tuxedo UID and GID information in the description field. This
functionality is not supported in previous releases of WebLogic
Tuxedo Connector.
Custom
plug-in provides the ability to write
your own AppKey generator class to provide the security information
required by Tuxedo. This functionality is not supported in previous
releases of WebLogic Tuxedo Connector.
void setAllowAnonymous(boolean AllowAnonymous) throws javax.management.InvalidAttributeValueException
Sets the value of the AllowAnonymous attribute.
AllowAnonymous
- Specify if anonymous user is allowed to access Tuxedojavax.management.InvalidAttributeValueException
getAllowAnonymous()
boolean getAllowAnonymous()
Specifies whether the anonymous user is allowed to access remote Tuxedo services.
Note: If the anonymous user is allowed to access Tuxedo,
the default AppKey will be used for TpUsrFile
and
LDAP
AppKey plug-ins. Interaction with the
Custom
AppKey plug-in depends on the design of the
Custom AppKey generator.
void setDefaultAppKey(int DfltAppKey) throws javax.management.InvalidAttributeValueException
Sets the value of the DefaultAppKey attribute.
DfltAppKey
- The default AppKey valuejavax.management.InvalidAttributeValueException
getDefaultAppKey()
int getDefaultAppKey()
The default AppKey
value to be used by the anonymous
user and other users who are not defined in the user database if
the plug-in allows them to access Tuxedo.
Note: The TpUsrFile
and LDAP
plug-ins do not allow users that are not defined in user database
to access Tuxedo unless Allow Anonymous is enabled.
void setTuxedoUidKw(java.lang.String UidKw) throws javax.management.InvalidAttributeValueException
Sets the value of the TuxedoUidKw attribute.
UidKw
- The Tuxedo user id keywordjavax.management.InvalidAttributeValueException
getTuxedoUidKw()
java.lang.String getTuxedoUidKw()
The keyword for Tuxedo UID (User ID) used in the
WlsUser
when using the Tuxedo migration utility
tpmigldap
. This keyword is only relevant if you
specify LDAP
as the AppKey Generator.)
Note: The keyword is used to find Tuxedo UID in the user record in the embedded LDAP database.
void setTuxedoGidKw(java.lang.String GidKw) throws javax.management.InvalidAttributeValueException
Sets the value of the TuxedoGidKw attribute.
GidKw
- The Tuxedo group id keywordjavax.management.InvalidAttributeValueException
getTuxedoGidKw()
java.lang.String getTuxedoGidKw()
The keyword for Tuxedo GID (Group ID) used in the
WlsUser
when using the Tuxedo migration utility
tpmigldap
. This field is only relevant if you specify
LDAP
as the AppKey Generator.)
Note: The keyword is used to find Tuxedo GID in the user record in the embedded LDAP database.
void setCustomAppKeyClass(java.lang.String AppKeyClass) throws javax.management.InvalidAttributeValueException
Sets the value of the CustomAppKeyClass attribute.
AppKeyClass
- The custom AppKey class full pathnamejavax.management.InvalidAttributeValueException
getCustomAppKeyClass()
java.lang.String getCustomAppKeyClass()
The full pathname to the custom AppKey
generator class.
(This class is only relevant if you specify Custom
as the
AppKey Generator.)
Note: This class is loaded at runtime if the
Custom
AppKey generator plug-in is selected.
void setCustomAppKeyClassParam(java.lang.String Param) throws javax.management.InvalidAttributeValueException
Sets the value of the CustomAppKeyClassParam attribute.
Param
- Optional parameter for information to be used by Custom
classjavax.management.InvalidAttributeValueException
getCustomAppKeyClassParam()
java.lang.String getCustomAppKeyClassParam()
The optional parameters to be used by the custom AppKey
class at the class initialization time. This class is only
relevant if you specify Custom
as the AppKey
Generator.)
void setKeepAlive(int KeepAlive) throws javax.management.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.javax.management.InvalidAttributeValueException
getKeepAlive()
int getKeepAlive()
Indicates whether this remote Tuxedo access point is configured with Application Level Keep Alive.
void setKeepAliveWait(int KeepAliveWait) throws javax.management.InvalidAttributeValueException
Sets the value of the KeepAliveWait attribute. The value of 0 means don't initiate Application Level KeepAlive, but acknowledge if one is received. 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 the amount of idle time, in milliseconds rounded to the nearest second.
KeepAliveWait
- The Application Level KeepAliveWait value.javax.management.InvalidAttributeValueException
getKeepAliveWait()
int getKeepAliveWait()
Indicates whether this remote Tuxedo access point requires the acknowledgement of Application Level Keep Alive. If the value is: