FederationServicesMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents configuration for SAML 1.1-based Federation Services, including the intersite transfer service, assertion consumer service, and assertion retrieval service.

       
Since9.1.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.FederationServicesMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Attributes

    This section describes the following attributes:


    ACSRequiresSSL

    Specifies whether the Assertion Consumer Service requires SSL.

           
    Privileges Read/Write
    Typeboolean
    Default Valuetrue

    ARSRequiresSSL

    Specifies whether the Assertion Retrieval Service requires SSL.

           
    Privileges Read/Write
    Typeboolean
    Default Valuetrue

    ARSRequiresTwoWaySSL

    Specifies whether the Assertion Retrieval Service requires two-way SSL authentication.

           
    Privileges Read/Write
    Typeboolean

    AssertionConsumerURIs

    The Assertion Consumer URIs.

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Default Value /samlacs/acs

    AssertionRetrievalURIs

    One or more URIs on which to listen for incoming assertion retrieval requests.

    For artifact profile, the destination site receives a SAML artifact that represents a source site (why we need the source site ID values) and an assertion ID. The destination site sends a request containing the artifact to the source site's assertion retrieval URL, and the source site responds with the corresponding assertion. You may configure multiple URIs here, although typically one will be sufficient. The URI includes the application context, followed by the resource context. For example:

    /my_application/saml/ars

    which would be accessible from the outside as https://my.example.com/my_application/saml/ars

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Default Value /samlars/ars

    AssertionStoreClassName

    The class that provides persistent storage for assertions, if you use an Assertion Store class other than the default class.

           
    Privileges Read/Write
    Typejava.lang.String

    AssertionStoreProperties

    Properties passed to Assertion Store class initStore() method.

    This may be useful if you have implemented a custom Assertion Store class.

           
    Privileges Read/Write
    Typejava.util.Properties

    CachingDisabled

    Private property that disables caching in proxies.

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

    DestinationSiteEnabled

    Specifies whether the Destination Site is enabled.

           
    Privileges Read/Write
    Typeboolean

    IntersiteTransferURIs

    The Intersite Transfer URIs.

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Default Value /samlits_ba/its /samlits_ba/its/post /samlits_ba/its/artifact /samlits_cc/its /samlits_cc/its/post /samlits_cc/its/artifact

    ITSRequiresSSL

    Specifies whether the Intersite Transfer Service requires SSL.

           
    Privileges Read/Write
    Typeboolean
    Default Valuetrue

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

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

    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

           
    Privileges Read/Write
    Typejava.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
    Typejava.lang.String

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.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

    POSTOneUseCheckEnabled

    Specifies whether the POST one-use check is enabled.

           
    Privileges Read/Write
    Typeboolean
    Default Valuetrue

    POSTRecipientCheckEnabled

    Specifies whether the POST recipient check is enabled. When true, the recipient of the SAML Response must match the URL in the HTTP Request.

           
    Privileges Read/Write
    Typeboolean
    Default Valuetrue

    Registered

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

    Deprecated.

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

    SigningKeyAlias

    The alias used to store and retrieve the Source Site's signing key in the keystore. This key is used to sign POST profile responses.

           
    Privileges Read/Write
    Typejava.lang.String

    SigningKeyPassPhrase

    The passphrase used to retrieve the Source Site's signing key from the keystore.

           
    Privileges Read/Write
    Typejava.lang.String
    Encryptedtrue

    SigningKeyPassPhraseEncrypted

    The encrypted passphrase used to retrieve the Source Site's signing key from the keystore.

    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.

           
    Privileges Read/Write
    Typebyte[]
    Encryptedtrue

    SourceIdBase64

    The Source Site ID base64-encoded.

    This read-only value is a Base64 representation of a 20-byte binary value that is calculated from the SourceSiteURL. If you want to configure ARTIFACT profile with another site, you will need to give a SourceId value to the other site. This value is are automatically updated when the SourceSiteURL changes.

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

    SourceIdHex

    The Source Site ID in hexadecimal.

    This read-only value is a hexadecimal representation of a 20-byte binary value that is calculated from the SourceSiteURL. If you want to configure ARTIFACT profile with another site, you will need to give a SourceId value to the other site. This value is are automatically updated when the SourceSiteURL changes.

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

    SourceSiteEnabled

    Indicates whether the Source Site is enabled.

           
    Privileges Read/Write
    Typeboolean

    SourceSiteURL

    The URL for the Source Site.

           
    Privileges Read/Write
    Typejava.lang.String

    SSLClientIdentityAlias

    The alias used to store and retrieve the Destination Site's SSL client identity in the keystore.

           
    Privileges Read/Write
    Typejava.lang.String

    SSLClientIdentityPassPhrase

    The passphrase used to retrieve the Destination Site's SSL client identity from the keystore.

           
    Privileges Read/Write
    Typejava.lang.String
    Encryptedtrue

    SSLClientIdentityPassPhraseEncrypted

    The encrypted passphrase used to retrieve the Destination Site's SSL client identity from the keystore.

    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.

           
    Privileges Read/Write
    Typebyte[]
    Encryptedtrue

    Type

    Returns the type of the MBean.

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

    UsedAssertionCacheClassName

    The class used as the persistent store for the Used Assertion Cache. When no class is specified, the default Used Assertion Cache implemention is used.

           
    Privileges Read/Write
    Typejava.lang.String

    UsedAssertionCacheProperties

    Properties to be passed to the Used Assertion Cache class.

           
    Privileges Read/Write
    Typejava.util.Properties


    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"
    ParametersObject [] {  attributeName }

    where:

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

      attributeName

    SignatureString [] { "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"
    ParametersObject [] {  propertyName }

    where:

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

      property to check

    SignatureString [] { "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"
    ParametersObject [] {  attributeName }

    where:

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

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

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

      property to restore

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