WebserviceTokenHandlerMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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

Since 9.0.0.0    
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
   
Factory Methods No factory methods. Instances of this MBean are created automatically.

Related MBeans

This section describes attributes that provide access to other 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.

    Factory Methods createConfigurationProperty (java.lang.String name)

    destroyConfigurationProperty (ConfigurationPropertyMBean wsc)

    Factory methods do not return objects.

    See Using factory methods.    

    Lookup Operation lookupConfigurationProperty(String name)

    Returns a javax.management.ObjectName for the instance of ConfigurationPropertyMBean named name.    

    Privileges Read only    
    Type ConfigurationPropertyMBean[]
    Relationship type: Containment.

    Attributes

    This section describes the following attributes:

     

    CachingDisabled

    Private property that disables caching in proxies.

       
    Privileges Read only    
    Type boolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

     

    ClassName

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

       
    Privileges Read/Write    
    Type java.lang.String

     

    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.

       
    Privileges Read/Write    
    Type int

     

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

       
    Privileges Read only    
    Type javax.management.MBeanInfo
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

     

    Name of

    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 of=user-specified-name

       
    Privileges Read/Write    
    Type java.lang.String

     

    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 &lt;. 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.

       
    Privileges Read/Write    
    Type java.lang.String

     

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    Deprecated.

       
    Privileges Read only    
    Type weblogic.management.WebLogicObjectName
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

     

    Parent

    Return the immediate parent for this MBean

       
    Privileges Read/Write    
    Type

     

    Registered

    Returns false if the the MBean represented by this object has been unregistered.

    Deprecated.

       
    Privileges Read only    
    Type boolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

     

    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".

       
    Privileges Read/Write    
    Type java.lang.String

     

    Type

    Returns the type of the MBean.

       
    Privileges Read only    
    Type java.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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

    Operation Name "freezeCurrentValue"    
    Parameters Object [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • javax.management.AttributeNotFoundException

    • javax.management.MBeanException

     

    isSet

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

    Operation Name "isSet"    
    Parameters Object [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check

    Signature String [] { "java.lang.String" }
    Returns boolean

     

    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

    Operation Name "restoreDefaultValue"    
    Parameters Object [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • javax.management.AttributeNotFoundException

     

    unSet

    Restore the given property to its default value.

    Operation Name "unSet"    
    Parameters Object [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore

    Signature String [] { "java.lang.String" }
    Returns void