WebserviceTokenHandlerMBean

Overview

Encapsulates information about a particular token handler that has been configured for a Web Service security configuration.

Fully Qualified Interface Name

If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.WebserviceTokenHandlerMBean

Since 9.0.0.0

Factory Methods

• Factory methods in WebserviceSecurityMBean

Child MBeans

This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

ConfigurationProperties

Specifies the list of properties that are associated with this credential provider or token handler.

Attributes

This section describes the following attributes:

ClassName

The fully qualified name of the class that implements a particular credential provider or token handler.

HandlingOrder

Specifies the order in which the token handlers execute on a given token.

If you do not specify an order, it is determined by the order in which you added the token handlers.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

Parent

Return the immediate parent for this MBean

TokenType

Specifies the type of token used for the particular credential provider or token handler.

WebLogic Server supports, by default, three types of tokens: X.509, UsernameToken, and SAML, as specified by the following WS-Security specifications:

• Web Services Security: Username Token Profile

• Web Services Security: X.509 Token Profile

• Web Services Security: SAML Token Profile

To specify one of these out-of-the-box types, use these values respectively: "ut", "x509", or "saml".

Type

Returns the type of the MBean.

Operations

This section describes the following operations:

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

Exceptions

• javax.management.AttributeNotFoundException
• javax.management.MBeanException

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

Exceptions

• javax.management.AttributeNotFoundException

unSet

Restore the given property to its default value.