WebserviceSecurityMBean

Overview | Related MBeans | Attributes | Operations

Overview

Encapsulates information about 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.WebserviceSecurityMBean`
Factory Methods	Factory methods in DomainMBean

Related MBeans

This section describes attributes that provide access to other MBeans.

WebserviceCredentialProviders
WebserviceSecurityTokens
WebserviceTimestamp

WebserviceTokenHandlers

WebserviceCredentialProviders

Specifies the list of credential providers that have been configured for this Web Service security configuration.

Factory Methods	`createWebserviceCredentialProvider (java.lang.String name)` `destroyWebserviceCredentialProvider (WebserviceCredentialProviderMBean wcp)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupWebserviceCredentialProvider(String name)` Returns a `javax.management.ObjectName` for the instance of `WebserviceCredentialProviderMBean` named `name`.
Privileges	Read only
Type	WebserviceCredentialProviderMBean[]
Relationship type:	Containment.

WebserviceSecurityTokens

Specifies the list of tokens that have been configured for this Web Service security configuration.

Factory Methods	`createWebserviceSecurityToken (java.lang.String name)` `destroyWebserviceSecurityToken (WebserviceSecurityTokenMBean wcp)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupWebserviceSecurityToken(String name)` Returns a `javax.management.ObjectName` for the instance of `WebserviceSecurityTokenMBean` named `name`.
Privileges	Read only
Type	WebserviceSecurityTokenMBean[]
Relationship type:	Containment.

WebserviceTimestamp

Specifies the timestamp information that has been configured for this Web Service security configuration.

Factory Methods	No explicit creator method. The child shares the lifecycle of its parent.
Privileges	Read only
Type	WebserviceTimestampMBean
Relationship type:	Containment.

WebserviceTokenHandlers

Specifies the list of token handlers that have been configured for this Web Service security configuration.

Factory Methods	`createWebserviceTokenHandler (java.lang.String name)` `destroyWebserviceTokenHandler (WebserviceTokenHandlerMBean wsth)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupWebserviceTokenHandler(String name)` Returns a `javax.management.ObjectName` for the instance of `WebserviceTokenHandlerMBean` named `name`.
Privileges	Read only
Type	WebserviceTokenHandlerMBean[]
Relationship type:	Containment.

Attributes

This section describes the following attributes:

CachingDisabled
CompatibilityOrderingPreference
CompatibilityPreference
DefaultCredentialProviderSTSURI
DynamicallyCreated
Id
MBeanInfo
Name

Notes
ObjectName
Parent
PolicySelectionPreference
Registered
Tags
Type

CachingDisabled

Private property that disables caching in proxies.

This attribute is not dynamic and requires a server restart to take effect.

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

CompatibilityOrderingPreference

Gets the value of the compatiblityOrderingPreference attribute.

Available Since	Release 10.3.3.0
Privileges	Read/Write
Type	java.lang.String

CompatibilityPreference

Gets the value of the compatiblityPreference attribute.

Available Since	Release 10.3.0.0
Privileges	Read/Write
Type	java.lang.String

DefaultCredentialProviderSTSURI

Gets the default STS endpoint URL for all WS-Trust enabled credential providers of this Web Service security configuration.

Available Since	Release 10.3.0.0
Privileges	Read/Write
Type	java.lang.String

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

This attribute is not dynamic and requires a server restart to take effect.

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

Id

Return the unique id of this MBean instance

This attribute is not dynamic and requires a server restart to take effect.

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

MBeanInfo

Returns the MBean info for this MBean.

This attribute is not dynamic and requires a server restart to take effect.

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

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

This attribute is not dynamic and requires a server restart to take effect.

Privileges	Read/Write
Type	java.lang.String

Notes

Optional information that you can include to describe this configuration.

WebLogic Server 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.

This attribute is not dynamic and requires a server restart to take effect.

Privileges	Read/Write
Security roles	Write access is granted only to the following roles: Deployer Operator
Type	java.lang.String

ObjectName

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

This attribute is not dynamic and requires a server restart to take effect.

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

This attribute is not dynamic and requires a server restart to take effect.

Privileges	Read/Write
Type

PolicySelectionPreference

Gets the value of the PolicySelectionPreference attribute.

The preference value can be one of the following:

NONE
SCP
SPC
CSP
CPS
PCS
PSC

Where: S: Security or functionality; C: Compatibility or Interoperability; P: Performance

If NONE is specified, no preference is applied - the first policy alternative is always chosen, and optional policy assertions are ignored.

Privileges	Read/Write
Type	java.lang.String
Default Value	NONE
Legal Values	NONE SCP SPC CSP CPS PCS PSC

Registered

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

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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

Type

Returns the type of the MBean.

This attribute is not dynamic and requires a server restart to take effect.

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:

addTag
freezeCurrentValue
getInheritedProperties
isInherited
isSet

removeTag
restoreDefaultValue
unSet

addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

Operation Name	`"addTag"`
Parameters	`Object [] { tag }` where: `tag` is an object of type `java.lang.String` that specifies: tag to be added to the MBean
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`
Exceptions	`java.lang.IllegalArgumentException` IllegalArgumentException if the tag contains illegal punctuation

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`

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

Operation Name	`"getInheritedProperties"`
Parameters	`Object [] { propertyNames }` where: `propertyNames` is an object of type `[Ljava.lang.String;` that specifies: properties to check
Signature	`String [] { "[Ljava.lang.String;" }`
Returns	`class`

isInherited

Check if the value of a property is inherited from template mbean or not.

Operation Name	`"isInherited"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: the name of the property
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`

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`

removeTag

Remove a tag from this Configuration MBean

Operation Name	`"removeTag"`
Parameters	`Object [] { tag }` where: `tag` is an object of type `java.lang.String` that specifies: tag to be removed from the MBean
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`
Exceptions	`java.lang.IllegalArgumentException` IllegalArgumentException if the tag contains illegal punctuation

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`

Available Since	Release 12.2.1.0.0
Privileges	Read/Write
Type	class java.lang.String[]