|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WTCRemoteTuxDomMBean
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.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
abstract String |
getAccessPoint() The unique name used to identify this remote Tuxedo access point. |
abstract 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. |
abstract String |
getAclPolicy() The inbound access control list (ACL) policy toward requests from a remote Tuxedo access point. |
abstract boolean |
getAllowAnonymous() Specifies whether the anonymous user is allowed to access remote Tuxedo services. |
abstract String |
getAppKey() Specifies the type of AppKey plug-in used. |
abstract int |
getCmpLimit() The compression threshold this remote Tuxedo access point uses when sending data to a local Tuxedo access point. |
abstract String |
getConnectionPolicy() The conditions under which this remote Tuxedo access point establishes a session connection with a local Tuxedo access point. |
abstract 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. |
abstract String |
getCredentialPolicy() The outbound access control list (ACL) policy toward requests to a remote Tuxedo access point. |
abstract String |
getCustomAppKeyClass() The full pathname to the custom AppKey generator class. |
abstract String |
getCustomAppKeyClassParam() The optional parameters to be used by the custom AppKey class at the class initialization time. |
abstract 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. |
abstract String |
getFederationName() The context at which this remote Tuxedo access point federates to a foreign name service. |
abstract String |
getFederationURL() The URL for a foreign name service that is federated into JNDI. |
abstract int |
getKeepAlive() Indicates whether this remote Tuxedo access point is configured with Application Level Keep Alive. |
abstract int |
getKeepAliveWait() Indicates whether this remote Tuxedo access point requires the acknowledgement of Application Level Keep Alive. |
abstract String |
getLocalAccessPoint() The local domain name from which this remote Tuxedo domain is reached. |
abstract String |
getMaxEncryptBits() The maximum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection. |
abstract long |
getMaxRetries() The maximum number of times that this remote Tuxedo access point tries to establish a session connections to local Tuxedo access points. |
abstract String |
getMinEncryptBits() The minimum encryption key length (in bits) this remote Tuxedo access point uses when establishing a session connection. |
abstract String |
getNWAddr() The network address and port number of this remote Tuxedo access point. |
abstract long |
getRetryInterval() The number of seconds that this remote Tuxedo access point waits between automatic connection attempts to local Tuxedo access points. |
abstract String |
getTpUsrFile() The full path to the user password file containing UID/GID information. |
abstract String |
getTuxedoGidKw() The keyword for Tuxedo GID (Group ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap . |
abstract String |
getTuxedoUidKw() The keyword for Tuxedo UID (User ID) used in the WlsUser when using the Tuxedo migration utility tpmigldap . |
abstract void |
setAccessPoint(String AccessPoint) Sets the value of the AccessPoint attribute. |
abstract void |
setAccessPointId(String AccessPointId) Sets the value of the AccessPointId attribute. |
abstract void |
setAclPolicy(String AclPolicy) Sets the value of the AclPolicy attribute. |
abstract void |
setAllowAnonymous(boolean AllowAnonymous) Sets the value of the AllowAnonymous attribute. |
abstract void |
setAppKey(String AppKey) Sets the value of the AppKey attribute. |
abstract void |
setCmpLimit(int CmpLimit) Sets the value of the CmpLimit attribute. |
abstract void |
setConnectionPolicy(String ConnectionPolicy) Sets the value of the ConnectionPolicy attribute. |
abstract void |
setConnPrincipalName(String ConnPrincipalName) Sets the value of the ConnPrincipalName attribute. |
abstract void |
setCredentialPolicy(String CredentialPolicy) Sets the value of the CredentialPolicy attribute. |
abstract void |
setCustomAppKeyClass(String AppKeyClass) Sets the value of the CustomAppKeyClass attribute. |
abstract void |
setCustomAppKeyClassParam(String Param) Sets the value of the CustomAppKeyClassParam attribute. |
abstract void |
setDefaultAppKey(int DfltAppKey) Sets the value of the DefaultAppKey attribute. |
abstract void |
setFederationName(String FederationName) Sets the value of the FederationName attribute. |
abstract void |
setFederationURL(String FederationURL) Sets the value of the FederationURL attribute. |
abstract void |
setKeepAlive(int KeepAlive) Sets the value of the KeepAlive attribute. |
abstract void |
setKeepAliveWait(int KeepAliveWait) Sets the value of the KeepAliveWait attribute. |
abstract void |
setLocalAccessPoint(String LocalAccessPoint) Sets the value of the LocalAccessPoint attribute. |
abstract void |
setMaxEncryptBits(String MaxEncryptBits) Sets the value of the MaxEncryptBits attribute. |
abstract void |
setMaxRetries(long MaxRetries) Sets the value of the MaxRetries attribute. |
abstract void |
setMinEncryptBits(String MinEncryptBits) Sets the value of the MinEncryptBits attribute. |
abstract void |
setNWAddr(String ListenAddress) Sets the value of the NWAddr attribute. |
abstract void |
setRetryInterval(long RetryInterval) Sets the value of the RetryInterval attribute. |
abstract void |
setTpUsrFile(String TpUsrFile) Sets the value of the TpUsrFile attribute. |
abstract void |
setTuxedoGidKw(String GidKw) Sets the value of the TuxedoGidKw attribute. |
abstract void |
setTuxedoUidKw(String UidKw) Sets the value of the TuxedoUidKw attribute. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Method Detail |
---|
void setAccessPoint(String AccessPoint) throws 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 pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getAccessPoint()
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(String AccessPointId) throws 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 identifierInvalidAttributeValueException
WTCRemoteTuxDomMBean.getAccessPointId()
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(String ConnectionPolicy) throws InvalidAttributeValueException
Sets the value of the ConnectionPolicy attribute.
ConnectionPolicy
- the connection policy for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getConnectionPolicy()
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(String AclPolicy) throws InvalidAttributeValueException
Sets the value of the AclPolicy attribute.
AclPolicy
- the AclPolicy for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getAclPolicy()
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(String CredentialPolicy) throws InvalidAttributeValueException
Sets the value of the CredentialPolicy attribute.
CredentialPolicy
- the CredentialPolicy for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getCredentialPolicy()
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(String TpUsrFile) throws InvalidAttributeValueException
Sets the value of the TpUsrFile attribute.
TpUsrFile
- the TpUsrFile URL for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getTpUsrFile()
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(String LocalAccessPoint) throws InvalidAttributeValueException
Sets the value of the LocalAccessPoint attribute.
LocalAccessPoint
- the name for the local Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getLocalAccessPoint()
String getLocalAccessPoint()
The local domain name from which this remote Tuxedo domain is reached.
void setConnPrincipalName(String ConnPrincipalName) throws InvalidAttributeValueException
Sets the value of the ConnPrincipalName attribute.
ConnPrincipalName
- The new connPrincipalName valueInvalidAttributeValueException
WTCRemoteTuxDomMBean.getConnPrincipalName()
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 InvalidAttributeValueException
Sets the value of the RetryInterval attribute.
RetryInterval
- the retry interval for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.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 InvalidAttributeValueException
Sets the value of the MaxRetries attribute.
MaxRetries
- the number of times to attempt connection to local Tuxedo access pointsInvalidAttributeValueException
WTCRemoteTuxDomMBean.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(String ListenAddress) throws InvalidAttributeValueException
Sets the value of the NWAddr attribute.
ListenAddress
- The new nWAddr valueInvalidAttributeValueException
WTCRemoteTuxDomMBean.getNWAddr()
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(String FederationURL) throws InvalidAttributeValueException
Sets the value of the FederationURL attribute.
FederationURL
- url for a foreign name service federated into JNDIInvalidAttributeValueException
WTCRemoteTuxDomMBean.getFederationURL()
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(String FederationName) throws InvalidAttributeValueException
Sets the value of the FederationName attribute.
FederationName
- context at which to federate to foreign name serviceInvalidAttributeValueException
WTCRemoteTuxDomMBean.getFederationName()
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 InvalidAttributeValueException
Sets the value of the CmpLimit attribute.
CmpLimit
- The compression threshold for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.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(String MinEncryptBits) throws InvalidAttributeValueException
Sets the value of the MinEncryptBits attribute.
MinEncryptBits
- The minimum encryption level desired for this remote Tuxedo access pointInvalidAttributeValueException
WTCRemoteTuxDomMBean.getMinEncryptBits()
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(String MaxEncryptBits) throws InvalidAttributeValueException
Sets the value of the MaxEncryptBits attribute.
MaxEncryptBits
- The maximum encryption level desired for this remote Tuxedo domainInvalidAttributeValueException
WTCRemoteTuxDomMBean.getMaxEncryptBits()
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 setAppKey(String AppKey) throws InvalidAttributeValueException
Sets the value of the AppKey attribute.
AppKey
- The type of appkey generator plug-in selected.InvalidAttributeValueException
WTCRemoteTuxDomMBean.getAppKey()
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 InvalidAttributeValueException
Sets the value of the AllowAnonymous attribute.
AllowAnonymous
- Specify if anonymous user is allowed to access TuxedoInvalidAttributeValueException
WTCRemoteTuxDomMBean.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 InvalidAttributeValueException
Sets the value of the DefaultAppKey attribute.
DfltAppKey
- The default AppKey valueInvalidAttributeValueException
WTCRemoteTuxDomMBean.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(String UidKw) throws InvalidAttributeValueException
Sets the value of the TuxedoUidKw attribute.
UidKw
- The Tuxedo user id keywordInvalidAttributeValueException
WTCRemoteTuxDomMBean.getTuxedoUidKw()
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(String GidKw) throws InvalidAttributeValueException
Sets the value of the TuxedoGidKw attribute.
GidKw
- The Tuxedo group id keywordInvalidAttributeValueException
WTCRemoteTuxDomMBean.getTuxedoGidKw()
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(String AppKeyClass) throws InvalidAttributeValueException
Sets the value of the CustomAppKeyClass attribute.
AppKeyClass
- The custom AppKey class full pathnameInvalidAttributeValueException
WTCRemoteTuxDomMBean.getCustomAppKeyClass()
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(String Param) throws InvalidAttributeValueException
Sets the value of the CustomAppKeyClassParam attribute.
Param
- Optional parameter for information to be used by Custom
classInvalidAttributeValueException
WTCRemoteTuxDomMBean.getCustomAppKeyClassParam()
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 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
WTCRemoteTuxDomMBean.getKeepAlive()
int getKeepAlive()
Indicates whether this remote Tuxedo access point is configured with Application Level Keep Alive.
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 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.InvalidAttributeValueException
WTCRemoteTuxDomMBean.getKeepAliveWait()
int getKeepAliveWait()
Indicates whether this remote Tuxedo access point requires the acknowledgement of Application Level Keep Alive. If the value is:
|
Copyright 1996, 2015, 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 Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |