This MBean represents configuration attributes for the WebLogic Credential Mapping provider.Deprecation of MBeanHome and Type-Safe InterfacesThis is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.
If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.security.providers.credentials.DefaultCredentialMapperMBean
No factory methods. Instances of this MBean are created automatically.
Because this MBean extends or implements CredentialMapperMBean, you can also access this MBean by retrieving CredentialMapperMBeans. The following attributes contain CredentialMapperMBeans and its subtypes:
|
|
This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.
|
|
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | RealmMBean |
This section describes the following attributes:
Returns whether this Credential Mapping provider stores stores credential maps created when deploying a resource adapter.
| Privileges | Read/Write |
| Type | boolean |
| Default Value | true |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A short description of the WebLogic Credential Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | WebLogic Credential Mapping Provider |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | DefaultCredentialMapper |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
No description provided.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | weblogic.security.providers.credentials.DefaultCredentialMapperProviderImpl |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The credential maps that you want to be exported from this Credential Mapping provider's database. If none are specified, all are exported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | passwords |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The format of the file to export. The list of supported export formats is determined by this Credential Mapping provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | DefaultCreds |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The credential maps that you want to be imported into this Credential Mapping provider's database. If none are specified, all are imported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The format of the fie to import. The list of supported import formats is determined by the Credential Mapping provider from which the credential maps were originally exported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | DefaultCreds |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The version of the WebLogic Credential Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | 1.0 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Advances the list to the next element in the list.
| Operation Name | "advance" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
weblogic.management.utils.InvalidCursorException
Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.
| Operation Name | "close" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
weblogic.management.utils.InvalidCursorException
Exports provider specific data in a specified format. When
errors occur, the MBean throws an ErrorCollectionException
containing a list of java.lang.Exceptions, where the
text of each exception describes the error.
| Operation Name | "exportData" |
| Parameters | Object [] {
format, filename, constraints }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns |
void
|
weblogic.management.utils.InvalidParameterException
weblogic.management.utils.ErrorCollectionException
Gets a password from a list that has been returned from the
listCredentials method. This method returns the
password that corresponds to current location in the list.
Deprecated in WLS 9.0
Deprecated.
| Operation Name | "getCurrentCredentialRemotePassword" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.InvalidCursorException
Gets a remote username from a list that has been returned from
the listCredentials method. This method returns the
remote username that corresponds to current location in the
list.
| Operation Name | "getCurrentCredentialRemoteUserName" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.InvalidCursorException
Gets an remote username from a credentials mapping that has been
returned from the listMappings method. This method
returns the remote username that corresponds to current location in
the list.
| Operation Name | "getCurrentMappingRemoteUserName" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.InvalidCursorException
Gets an resource id from a credentials map that has been
returned from the listMappingsByPattern method. This
method returns the resource id that corresponds to current location
in the list.
| Operation Name | "getCurrentMappingResourceID" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.InvalidCursorException
Gets a webLogic username from a credentials mapping that has
been returned from the listMappings method. This
method returns the local webLogic username that corresponds to
current location in the list.
| Operation Name | "getCurrentMappingWLSUserName" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.InvalidCursorException
Gets the remote password corresponding to the remote username in the credential created for the specified resource. Deprecated in WLS 9.0
Deprecated.
| Operation Name | "getRemotePassword" |
| Parameters | Object [] {
resourceId, remoteUserName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.NotFoundException
Gets the external username that is mapped to a local webLogic username for the specified resource.
| Operation Name | "getRemoteUserName" |
| Parameters | Object [] {
resourceId, wlsUserName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
weblogic.management.utils.NotFoundException
Returns true if there are more objects in the list, and false otherwise.
| Operation Name | "haveCurrent" |
| Parameters | Object [] {
cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
weblogic.management.utils.InvalidCursorException
Imports provider specific data from a specified format. When
errors occur, the MBean throws an ErrorCollectionException
containing a list of java.lang.Exceptions, where the
text of each exception describes the error.
| Operation Name | "importData" |
| Parameters | Object [] {
format, filename, constraints }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.util.Properties" } |
| Returns |
void
|
weblogic.management.utils.InvalidParameterException
weblogic.management.utils.ErrorCollectionException
Gets a list of credentials mapped to the resource. Returns a
cursor as a string. Use the
getCurrentCredentialRemoteUserName and
getCurrentCredentialRemotePassword methods to get the
username and password for the current item in the list.
| Operation Name | "listCredentials" |
| Parameters | Object [] {
resourceId }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
Gets a list of credential mappings created for the given
resource id. Returns a cursor as a string. Use the
getCurrentMappingWLSUserName and
getCurrentMappingRemoteUserName methods to return the
webLogic username and remote user name for the current item in the
list.
| Operation Name | "listMappings" |
| Parameters | Object [] {
resourceId }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
Gets a list of all credential mappings with the resource id
matching the specified resource id pattern. Returns a cursor as a
string. Use the getCurrentMappingWLSUserName and
getCurrentMappingRemoteUserName() and
getCurrentMappingResourceID() methods to return the
WebLogic username and external user name and the current resource
ID for the current item in the list.
| Operation Name | "listMappingsByPattern" |
| Parameters | Object [] {
resourceIdPattern, maxToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
Removes the credential that is created on the specified resource and remote username. If you created a credential map that specifies this username, the map becomes invalid. Users must remove any credential mappings created for the credential and the specified resource before removing the credential.
| Operation Name | "removeUserPasswordCredential" |
| Parameters | Object [] {
resourceId, remoteUserName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
weblogic.management.utils.NotFoundException
Removes the mapping from a webLogic username to a remote username-password credential for the specified resource.
| Operation Name | "removeUserPasswordCredentialMapping" |
| Parameters | Object [] {
resourceId, wlsUserName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
weblogic.management.utils.NotFoundException
Sets a remote user-password credential for the specified resource. If a new new username is specified, this method creates a new user-password credential. If you specify an existing username, this method replaces the user's password.
| Operation Name | "setUserPasswordCredential" |
| Parameters | Object [] {
resourceId, remoteUserName, remotePassword }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
Creates a mapping from a webLogic username to a remote username-password credential for the specified resource. The credential for the remoteusername for the specified resource should be created before this mapping is created.
| Operation Name | "setUserPasswordCredentialMapping" |
| Parameters | Object [] {
resourceId, wlsUserName, remoteUserName }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
weblogic.management.utils.NotFoundException
| Operation Name | "wls_getDisplayName" |
| Parameters | null |
| Signature | null |
| Returns | String
|