BEA Systems, Inc.

Type-Safe Access to BEA WebLogic Server 9.1 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)


weblogic.security.providers.credentials
Interface PKICredentialMapperMBean

All Superinterfaces:
ApplicationVersionerMBean, CredentialMapperMBean, weblogic.descriptor.DescriptorBean, ExportMBean, ImportMBean, ListerMBean, PKICredentialMapEditorMBean, PKICredentialMapReaderMBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

public interface PKICredentialMapperMBean
extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, CredentialMapperMBean, PKICredentialMapEditorMBean, ApplicationVersionerMBean, ImportMBean, ExportMBean

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

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary
 String getDescription()
          A short description of the PKI Credential Mapping provider.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.commo.StandardInterface
setName, wls_getDisplayName, wls_getInterfaceClassName, wls_getObjectName
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener
 
Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet
 
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.ImportMBean
importData
 
Methods inherited from interface weblogic.management.security.ExportMBean
exportData
 

Method Detail

getDescription

public 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"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

getKeyStoreFileName

public String getKeyStoreFileName()
Location of the keystore relative to the directory where the server was started.

Default value:
""
A dynamic MBean attribute.
false

getKeyStorePassPhrase

public String getKeyStorePassPhrase()
The Keystore password.

Default value:
""
A dynamic MBean attribute.
false

getKeyStorePassPhraseEncrypted

public byte[] getKeyStorePassPhraseEncrypted()
A dynamic MBean attribute.
false

getKeyStoreProvider

public String getKeyStoreProvider()
Represents a provider for the Java Security API that should be used.

Default value:
""
A dynamic MBean attribute.
false

getKeyStoreType

public String getKeyStoreType()
The provider will generate a keystore object of this type. Default is JKS.

Default value:
"JKS"
A dynamic MBean attribute.
false

getName

public 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 weblogic.management.commo.StandardInterface
Default value:
"PKICredentialMapper"
A dynamic MBean attribute.
false

getProviderClassName

public String getProviderClassName()
The name of the Java class that loads the PKI Credential Mapping provider.

Specified by:
getProviderClassName in interface ProviderMBean
Default value:
"weblogic.security.providers.credentials.PKICredentialMapperProviderImpl"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.
Excluded: Should not appear in public javadocs
Internal: Should not appear in public javadocs

getSupportedExportConstraints

public 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"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

getSupportedExportFormats

public 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"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

getSupportedImportConstraints

public String[] getSupportedImportConstraints()
The PKI credential maps that you want to be imported into this Credential Mapping provider's database. If no constraintsare specified, all are imported.

Specified by:
getSupportedImportConstraints in interface ImportMBean
Default value:
""
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

getSupportedImportFormats

public 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"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

getVersion

public String getVersion()
The version of the PKI Credential Mapping provider.

Specified by:
getVersion in interface ProviderMBean
Default value:
"1.0"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

isUseInitiatorGroupNames

public boolean isUseInitiatorGroupNames()
Specifies whether to enables selection of credential mappings based on the group names of the initiator.

Default value:
true
A dynamic MBean attribute.
false

isUseResourceHierarchy

public boolean isUseResourceHierarchy()
Specifies whether to enable selection of credential mappings by traversing up the resource hierachy for each type of resource

Default value:
true
A dynamic MBean attribute.
false

setKeyStoreFileName

public 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:
""
A dynamic MBean attribute.
false

setKeyStorePassPhrase

public void setKeyStorePassPhrase(String newValue)
                           throws InvalidAttributeValueException
The Keystore password.

Parameters:
newValue - - new value for attribute KeyStorePassPhrase
Throws:
InvalidAttributeValueException
Default value:
""
A dynamic MBean attribute.
false

setKeyStorePassPhraseEncrypted

public void setKeyStorePassPhraseEncrypted(byte[] _bytes)
A dynamic MBean attribute.
false

setKeyStoreProvider

public 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:
""
A dynamic MBean attribute.
false

setKeyStoreType

public 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"
A dynamic MBean attribute.
false

setUseInitiatorGroupNames

public 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
A dynamic MBean attribute.
false

setUseResourceHierarchy

public 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
A dynamic MBean attribute.
false

Documentation is available at
http://e-docs.bea.com/wls/docs91
Copyright 2005 BEA Systems Inc.