Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.3)

Part Number E13945-03

weblogic.security.providers.credentials
Interface PKICredentialMapperMBean

All Superinterfaces:
ApplicationVersionerMBean, CredentialMapperMBean, ExportMBean, ImportMBean, ListerMBean, PKICredentialMapEditorMBean, PKICredentialMapReaderMBean, ProviderMBean

public interface PKICredentialMapperMBean
extends CredentialMapperMBean, PKICredentialMapEditorMBean, ApplicationVersionerMBean, ImportMBean, ExportMBean

This MBean represents configuration attributes for the PKI Credential Mapping provider.


Method Summary
 String getDescription()
          A short description of the PKI Credential Mapping provider.
 String getKeyStoreFileName()
          Location of the keystore relative to the directory where the server was started.
 String getKeyStorePassPhrase()
          The Keystore password.
 byte[] getKeyStorePassPhraseEncrypted()
           
 String getKeyStoreProvider()
          Represents a provider for the Java Security API that should be used.
 String getKeyStoreType()
          The provider will generate a keystore object of this type.
 String getName()
          The name of this configuration.
 String getProviderClassName()
          The name of the Java class that loads the PKI Credential Mapping provider.
 String[] getSupportedExportConstraints()
          The credential maps that you want to be exported from this PKI Credential Mapping provider's database.
 String[] getSupportedExportFormats()
          The format of the file to export.
 String[] getSupportedImportConstraints()
          The PKI credential maps that you want to be imported into this Credential Mapping provider's database.
 String[] getSupportedImportFormats()
          The format of the file to import.
 String getVersion()
          The version of the PKI Credential Mapping provider.
 boolean isUseInitiatorGroupNames()
          Specifies whether to enables selection of credential mappings based on the group names of the initiator.
 boolean isUseResourceHierarchy()
          Specifies whether to enable selection of credential mappings by traversing up the resource hierachy for each type of resource
 void setKeyStoreFileName(String newValue)
          Location of the keystore relative to the directory where the server was started.
 void setKeyStorePassPhrase(String newValue)
          The Keystore password.
 void setKeyStorePassPhraseEncrypted(byte[] _bytes)
           
 void setKeyStoreProvider(String newValue)
          Represents a provider for the Java Security API that should be used.
 void setKeyStoreType(String newValue)
          The provider will generate a keystore object of this type.
 void setUseInitiatorGroupNames(boolean newValue)
          Specifies whether to enables selection of credential mappings based on the group names of the initiator.
 void setUseResourceHierarchy(boolean newValue)
          Specifies whether to enable selection of credential mappings by traversing up the resource hierachy for each type of resource
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getRealm
 
Methods inherited from interface weblogic.management.security.credentials.PKICredentialMapEditorMBean
removePKICredentialMapping, setCertificateCredential, setKeypairCredential
 
Methods inherited from interface weblogic.management.security.credentials.PKICredentialMapReaderMBean
getCertificate, getCurrentCredAction, getCurrentCredential, getCurrentInitiatorName, getCurrentResourceId, getKeystoreAlias, isInitiatorUserName, listAllCertEntryAliases, listAllKeypairEntryAliases, listMappings, listMappingsByPattern
 
Methods inherited from interface weblogic.management.utils.ListerMBean
advance, close, haveCurrent
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getRealm
 
Methods inherited from interface weblogic.management.security.ImportMBean
importData
 
Methods inherited from interface weblogic.management.security.ExportMBean
exportData
 

Method Detail

getProviderClassName

String getProviderClassName()

The name of the Java class that loads the PKI Credential Mapping provider.

Default Value:
"weblogic.security.providers.credentials.PKICredentialMapperProviderImpl"

getDescription

String getDescription()

A short description of the PKI Credential Mapping provider.

A short description of the PKI Credential Mapping provider.

Specified by:
getDescription in interface ProviderMBean
Default Value:
"PKI Credential Mapping Provider"

getVersion

String getVersion()

The version of the PKI Credential Mapping provider.

Specified by:
getVersion in interface ProviderMBean
Default Value:
"1.0"

getSupportedImportFormats

String[] getSupportedImportFormats()

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.

Specified by:
getSupportedImportFormats in interface ImportMBean
Default Value:
"PKICreds"

getSupportedImportConstraints

String[] getSupportedImportConstraints()

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.

Specified by:
getSupportedImportConstraints in interface ImportMBean
Default Value:
""

getSupportedExportFormats

String[] getSupportedExportFormats()

The format of the file to export. The list of supported export formats is determined by this PKI Credential Mapping provider.

Specified by:
getSupportedExportFormats in interface ExportMBean
Default Value:
"PKICreds"

getSupportedExportConstraints

String[] getSupportedExportConstraints()

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.

Specified by:
getSupportedExportConstraints in interface ExportMBean
Default Value:
"passwords"

getKeyStoreType

String getKeyStoreType()

The provider will generate a keystore object of this type. Default is JKS.

Default Value:
"JKS"

setKeyStoreType

void setKeyStoreType(String newValue)
                     throws InvalidAttributeValueException

The provider will generate a keystore object of this type. Default is JKS.

Parameters:
newValue - - new value for attribute KeyStoreType
Throws:
InvalidAttributeValueException
Default Value:
"JKS"

getKeyStoreProvider

String getKeyStoreProvider()

Represents a provider for the Java Security API that should be used.

Default Value:
""

setKeyStoreProvider

void setKeyStoreProvider(String newValue)
                         throws InvalidAttributeValueException

Represents a provider for the Java Security API that should be used.

Parameters:
newValue - - new value for attribute KeyStoreProvider
Throws:
InvalidAttributeValueException
Default Value:
""

getKeyStoreFileName

String getKeyStoreFileName()

Location of the keystore relative to the directory where the server was started.

Default Value:
""

setKeyStoreFileName

void setKeyStoreFileName(String newValue)
                         throws InvalidAttributeValueException

Location of the keystore relative to the directory where the server was started.

Parameters:
newValue - - new value for attribute KeyStoreFileName
Throws:
InvalidAttributeValueException
Default Value:
""

getKeyStorePassPhrase

String getKeyStorePassPhrase()

The Keystore password.

Default Value:
""

setKeyStorePassPhrase

void setKeyStorePassPhrase(String newValue)
                           throws InvalidAttributeValueException

The Keystore password.

Parameters:
newValue - - new value for attribute KeyStorePassPhrase
Throws:
InvalidAttributeValueException
Default Value:
""

isUseResourceHierarchy

boolean isUseResourceHierarchy()

Specifies whether to enable selection of credential mappings by traversing up the resource hierachy for each type of resource

Default Value:
true

setUseResourceHierarchy

void setUseResourceHierarchy(boolean newValue)
                             throws InvalidAttributeValueException

Specifies whether to enable selection of credential mappings by traversing up the resource hierachy for each type of resource

Parameters:
newValue - - new value for attribute UseResourceHierarchy
Throws:
InvalidAttributeValueException
Default Value:
true

isUseInitiatorGroupNames

boolean isUseInitiatorGroupNames()

Specifies whether to enables selection of credential mappings based on the group names of the initiator.

Default Value:
true

setUseInitiatorGroupNames

void setUseInitiatorGroupNames(boolean newValue)
                               throws InvalidAttributeValueException

Specifies whether to enables selection of credential mappings based on the group names of the initiator.

Parameters:
newValue - - new value for attribute UseInitiatorGroupNames
Throws:
InvalidAttributeValueException
Default Value:
true

getName

String getName()
Description copied from interface: ProviderMBean
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:
getName in interface ProviderMBean
Default Value:
"PKICredentialMapper"

setKeyStorePassPhraseEncrypted

void setKeyStorePassPhraseEncrypted(byte[] _bytes)

getKeyStorePassPhraseEncrypted

byte[] getKeyStorePassPhraseEncrypted()

Copyright 1996, 2010, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.3)

Part Number E13945-03