weblogic.security.providers.saml.registry
Interface SAMLPartnerRegistryMBean

All Superinterfaces:

weblogic.descriptor.DescriptorBean, ExportMBean, ImportMBean, ListerMBean, NameListerMBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

All Known Subinterfaces:

SAMLAssertingPartyRegistryMBean, SAMLCredentialMapperV2MBean, SAMLIdentityAsserterV2MBean, SAMLRelyingPartyRegistryMBean

public interface SAMLPartnerRegistryMBean
extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, ProviderMBean, ImportMBean, ExportMBean, NameListerMBean

No description provided.

Method Summary

boolean	certificateExists(String alias) No description provided.
void	copyToDER(String alias, String certificateFile) No description provided.
void	copyToPEM(String alias, String certificateFile) No description provided.
X509Certificate	getCertificate(String alias) No description provided.
String	getName() The name of this configuration.
String[]	getSupportedExportConstraints() No description provided.
String[]	getSupportedExportFormats() No description provided.
String[]	getSupportedImportConstraints() No description provided.
String[]	getSupportedImportFormats() No description provided.
String	listCertificates(String aliasWildcard, int maxToReturn) No description provided.
void	registerCertificate(String alias, String certificateFile) No description provided.
void	unregisterCertificate(String alias) No description provided.

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

getDescription, getRealm, getVersion

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.ImportMBean

importData

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.ExportMBean

exportData

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.utils.NameListerMBean

getCurrentName

Methods inherited from interface weblogic.management.utils.ListerMBean

advance, close, haveCurrent

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

Method Detail

getSupportedImportFormats

String[] getSupportedImportFormats()

No description provided.

Specified by:

getSupportedImportFormats in interface ImportMBean

Default Value:

"XML Partner Registry","JKS KeyStore"

getSupportedImportConstraints

String[] getSupportedImportConstraints()

No description provided.

Specified by:

getSupportedImportConstraints in interface ImportMBean

Default Value:

"Partners","Certificates","ImportMode"

getSupportedExportFormats

String[] getSupportedExportFormats()

No description provided.

Specified by:

getSupportedExportFormats in interface ExportMBean

Default Value:

"XML Partner Registry","JKS KeyStore","LDIF Template"

getSupportedExportConstraints

String[] getSupportedExportConstraints()

No description provided.

Specified by:

getSupportedExportConstraints in interface ExportMBean

Default Value:

"Partners","Certificates","Passwords"

registerCertificate

void registerCertificate(String alias,
                         String certificateFile)
                         throws weblogic.management.utils.AlreadyExistsException,
                                weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

alias - - The alias to register the certificate under. It must not be empty or null. Aliases are case-insensitive.

certificateFile - - The pathname (relative to the directory the admin server is booted from) of a PEM or DER file containing the certificate to be registered.

Throws:

weblogic.management.utils.AlreadyExistsException

weblogic.management.utils.InvalidParameterException

unregisterCertificate

void unregisterCertificate(String alias)
                           throws weblogic.management.utils.NotFoundException,
                                  weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

listCertificates

String listCertificates(String aliasWildcard,
                        int maxToReturn)
                        throws weblogic.management.utils.InvalidCursorException,
                               weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

aliasWildcard - - A wild card used to select aliases. It supports three formats: "*" matches all aliases. "foo*" matches all aliases starting with the string "foo". "foo" matches the alias "foo" only. The matches are case-insensitive.

maxToReturn - - The maximum number of aliases this method may return. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort the results. Set this parameter to zero to return all matching aliases.

Throws:

weblogic.management.utils.InvalidCursorException

weblogic.management.utils.InvalidParameterException

getCertificate

X509Certificate getCertificate(String alias)
                               throws weblogic.management.utils.NotFoundException,
                                      weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

certificateExists

boolean certificateExists(String alias)
                          throws weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

Throws:

weblogic.management.utils.InvalidParameterException

copyToPEM

void copyToPEM(String alias,
               String certificateFile)
               throws weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

certificateFile - - The pathname (relative to the directory the admin server is booted from) of the file to write the certificate to.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

copyToDER

void copyToDER(String alias,
               String certificateFile)
               throws weblogic.management.utils.NotFoundException,
                      weblogic.management.utils.InvalidParameterException

No description provided.

Parameters:

alias - - The alias the certificate is registered under. It must not be empty or null. Aliases are case-insensitive.

certificateFile - - The pathname (relative to the directory the admin server is booted from) of the file to write the certificate to.

Throws:

weblogic.management.utils.NotFoundException

weblogic.management.utils.InvalidParameterException

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

Specified by:

getName in interface weblogic.management.commo.StandardInterface

Default Value:

"SAMLPartnerRegistry"