This MBean represents configuration for SAML 1.1-based Federation Services, including the intersite transfer service, assertion consumer service, and assertion retrieval service.
Since | 9.1.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.FederationServicesMBean
|
Factory Methods | No factory methods. Instances of this MBean are created automatically. |
This section describes the following attributes:
Specifies whether the Assertion Consumer Service requires SSL.
Privileges | Read/Write |
Type | boolean |
Default Value | true |
Specifies whether the Assertion Retrieval Service requires SSL.
Privileges | Read/Write |
Type | boolean |
Default Value | true |
Specifies whether the Assertion Retrieval Service requires two-way SSL authentication.
Privileges | Read/Write |
Type | boolean |
The Assertion Consumer URIs.
Privileges | Read/Write |
Type | class java.lang.String[] |
Default Value | /samlacs/acs |
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 |
Type | class java.lang.String[] |
Default Value | /samlars/ars |
The class that provides persistent storage for assertions, if you use an Assertion Store class other than the default class.
Privileges | Read/Write |
Type | java.lang.String |
Properties passed to Assertion Store class initStore() method.
This may be useful if you have implemented a custom Assertion Store class.
Privileges | Read/Write |
Type | java.util.Properties |
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. |
Specifies whether the Destination Site is enabled.
Privileges | Read/Write |
Type | boolean |
The Intersite Transfer URIs.
Privileges | Read/Write |
Type | class 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 |
Specifies whether the Intersite Transfer Service requires SSL.
Privileges | Read/Write |
Type | boolean |
Default Value | true |
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. |
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 |
Type | java.lang.String |
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.
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 |
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. |
Return the immediate parent for this MBean
Privileges | Read/Write |
Type |
Specifies whether the POST one-use check is enabled.
Privileges | Read/Write |
Type | boolean |
Default Value | true |
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 |
Type | boolean |
Default Value | true |
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. |
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 |
Type | java.lang.String |
The passphrase used to retrieve the Source Site's signing key from the keystore.
Privileges | Read/Write |
Type | java.lang.String |
Encrypted | true |
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.
For more information, see:
Privileges | Read/Write |
Type | byte[] |
Encrypted | true |
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 |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Indicates whether the Source Site is enabled.
Privileges | Read/Write |
Type | boolean |
The URL for the Source Site.
Privileges | Read/Write |
Type | java.lang.String |
The alias used to store and retrieve the Destination Site's SSL client identity in the keystore.
Privileges | Read/Write |
Type | java.lang.String |
The passphrase used to retrieve the Destination Site's SSL client identity from the keystore.
Privileges | Read/Write |
Type | java.lang.String |
Encrypted | true |
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.
For more information, see:
Privileges | Read/Write |
Type | byte[] |
Encrypted | true |
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. |
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 |
Type | java.lang.String |
Properties to be passed to the Used Assertion Cache class.
Privileges | Read/Write |
Type | java.util.Properties |
This section describes the following operations:
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.
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.
Operation Name | "freezeCurrentValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
Operation Name | "isSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
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.
Operation Name | "restoreDefaultValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Restore the given property to its default value.
Operation Name | "unSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|