This MBean represents configuration attributes for the PKI Credential Mapping provider.
| 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.security.providers.credentials.PKICredentialMapperMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Access Points Inherited from CredentialMapperMBean |
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 provide access to other MBeans.
|
|
Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.
| Privileges | Read only |
| Type | RealmMBean |
| Relationship type: | Reference. |
This section describes the following attributes:
A short description of the PKI Credential Mapping provider.
A short description of the PKI Credential Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | PKI Credential Mapping Provider |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Location of the keystore relative to the directory where the server was started.
| Privileges | Read/Write |
| Type | java.lang.String |
| Default Value |
The Keystore password.
| Privileges | Read/Write |
| Type | java.lang.String |
| Default Value | |
| Encrypted | true |
| Privileges | Read/Write |
| Type | byte[] |
| Encrypted | true |
Represents a provider for the Java Security API that should be used.
| Privileges | Read/Write |
| Type | java.lang.String |
| Default Value |
The provider will generate a keystore object of this type. Default is JKS.
| Privileges | Read/Write |
| Type | java.lang.String |
| Default Value | JKS |
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | PKICredentialMapper |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The name of the Java class that loads the PKI Credential Mapping provider.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | weblogic.security.providers.credentials.PKICredentialMapperProviderImpl |
| 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 PKI Credential Mapping provider's database. If no constraints 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 PKI Credential Mapping provider.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | PKICreds |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The PKI credential maps that you want to be imported into this Credential Mapping provider's database. If no constraints 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 file to import. The list of supported import formats is determined by the PKI Credential Mapping provider from which the credential maps were originally exported.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | PKICreds |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Specifies whether to enables selection of credential mappings based on the group names of the initiator.
| Privileges | Read/Write |
| Type | boolean |
| Default Value | true |
Specifies whether to enable selection of credential mappings by traversing up the resource hierachy for each type of resource
| Privileges | Read/Write |
| Type | boolean |
| Default Value | true |
The version of the PKI 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
|
| Exceptions |
|
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
|
| Exceptions |
|
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
|
| Exceptions |
|
For a certificate entry this method will return the certificate corresponding to the alias. For a keyentry it will return the first Certificate entry in a CertificateChain.
| Operation Name | "getCertificate" |
| Parameters | Object [] { keystoreAlias }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Certificate
|
| Exceptions |
|
Gets an credential action from a list that has been returned
from the listMappings or the
listMappingsByPattern() method. This method returns
the credential action that corresponds to current location in the
list.
| Operation Name | "getCurrentCredAction" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Gets the keystore alias from a credentials map that has been
returned from the listMappings or the
listMappingsByPattern() method. This method returns
the keystore alias that corresponds to current location in the
list.
| Operation Name | "getCurrentCredential" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Gets an identity domain associated with the user from a list
that has been returned from the listMappings or the
listMappingsByPattern() method. This method returns
the identity domain associated with the username that corresponds
to current location in the list.
| Operation Name | "getCurrentInitiatorIdentityDomain" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Gets an username from a list that has been returned from the
listMappings or the
listMappingsByPattern() method. This method returns
the username that corresponds to current location in the list.
| Operation Name | "getCurrentInitiatorName" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Gets the current resource id from a list that has been returned
from the and listMappingsByPattern() method. This
method returns the resource id that corresponds to current location
in the list.
| Operation Name | "getCurrentResourceId" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Gets the keystore alias that is mapped to a username for a particular resource and credential action.
| Operation Name | "getKeystoreAlias" |
| Parameters | Object [] { resourceId, userName, identityDomain, isInitiatorUserName, credAction, credType }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
Gets the keystore alias that is mapped to a username for a particular resource and credential action.
| Operation Name | "getKeystoreAlias" |
| Parameters | Object [] { resourceId, userName, isInitiatorUserName, credAction, credType }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
| Exceptions |
|
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
|
| Exceptions |
|
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
|
| Exceptions |
|
Returns whether the initiator name from a list that has been
returned from the listMappings or the
listMappingsByPattern()method is a user name or a
group name. Method returns true if the username returned by the
getCurrentInitiatorName is a user name. If the initiator name
returned is a Group name this method returns false.
| Operation Name | "isInitiatorUserName" |
| Parameters | Object [] { cursor }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| 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
|
| Exceptions |
|
Returns a list of all the public certificate aliases currently configured in the keystore. Console can call this method to display a list of all possible certificate aliases.
| Operation Name | "listAllCertEntryAliases" |
| Parameters | null |
| Signature | null |
| Returns |
class |
| Exceptions |
|
Returns a list of all the key pair aliases that currently configured in the keystore. Console can call this method to display a list of all possible keypair aliases.
| Operation Name | "listAllKeypairEntryAliases" |
| Parameters | null |
| Signature | null |
| Returns |
class |
| Exceptions |
|
Gets a list of usernames, credential actions, keystore aliases
and their passwords. Returns a cursor as a string. Use the
getCurrentUserName(),getCurrentCredential(),
getCurrentCredAction() methods to get the username,
keystore alias and credential action for the current item in the
list.
| Operation Name | "listMappings" |
| Parameters | Object [] { resourceId, credType }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | String
|
Gets a list of all the configured credential mappings. Returns a
cursor as a string. Use the getCurrentUserName(),
getCurrentCredAction(),
getCurrentResourceId(),
getCurrentCredential() methods to get the username,
credential action, resource id and keystore alias for the current
item in the list.
| Operation Name | "listMappingsByPattern" |
| Parameters | Object [] { resourceIdPattern, maxToReturn, credType }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer",
"java.lang.String" } |
| Returns | String
|
Removes the mapping between the principalName, resourceid and credential action to the keystore alias.
| Operation Name | "removePKICredentialMapping" |
| Parameters | Object [] { resourceId, principalName, identityDomain, isInitiatorUserName, credAction, credType }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Removes the mapping between the principalName, resourceid and credential action to the keystore alias.
| Operation Name | "removePKICredentialMapping" |
| Parameters | Object [] { resourceId, principalName, isInitiatorUserName, credAction, credType }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Creates a public certificate mapping between the principalName, resourceid and credential action to the keystore alias.
| Operation Name | "setCertificateCredential" |
| Parameters | Object [] { resourceId, principalName, identityDomain, isInitiatorUserName, credAction, keystoreAlias }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Creates a public certificate mapping between the principalName, resourceid and credential action to the keystore alias.
| Operation Name | "setCertificateCredential" |
| Parameters | Object [] { resourceId, principalName, isInitiatorUserName, credAction, keystoreAlias }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Creates a keypair mapping between the principalName, resourceid and credential action to the keystore alias and the corresponding password.
| Operation Name | "setKeypairCredential" |
| Parameters | Object [] { resourceId, principalName, identityDomain, isInitiatorUserName, credAction, keystoreAlias, password }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String",
"[C" } |
| Returns |
void
|
| Exceptions |
|
Creates a keypair mapping between the principalName, resourceid and credential action to the keystore alias and the corresponding password.
| Operation Name | "setKeypairCredential" |
| Parameters | Object [] { resourceId, principalName, isInitiatorUserName, credAction, keystoreAlias, password }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.Boolean",
"java.lang.String",
"java.lang.String",
"[C" } |
| 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
|
| Exceptions |
|
Returns the display name of an MBean.
Deprecated 9.0.0.0
| Operation Name | "wls_getDisplayName" |
| Parameters | null |
| Signature | null |
| Returns | String
|