CertRegManagerMBean (Abstract)


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

The CertRegManager is used manage a certificate registry that is stored in the embedded LDAP server. This is utility code that is shared by the CertificateRegistry and SAML.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://edocs.bea.com.

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

Factory Methods

No factory methods. Instances of this MBean are created automatically.

Subtypes

The following MBeans extend or implement this MBean type:


    Child MBeans

    This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


      Realm

      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
      TypeRealmMBean


      Attributes

      This section describes the following attributes:


      Description

      Returns a description of this security provider.

      Each security provider's mbean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's mbean hard-wires its description. There are no conventions on the contents of the description. It should be a human readable string that gives a brief description of the security provider.

             
      Privileges Read only
      Typejava.lang.String
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Name

             
      Privileges Read only
      Typejava.lang.String
      Default ValueCertRegManager
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedExportConstraints

      A certificate registry always exports all the certificates in the registry thus does not support export constraints.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedExportFormats

      A certificate registry exports trusted CAs to a JKS keystore. The keystore must not already exist.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value JKS KeyStore
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedImportConstraints

      A certificate registry always imports all the certificates in a keystore (identities and trusted CAs) thus does not support export constraints.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SupportedImportFormats

      A certificate registry imports trusted CAs from a JKS keystore.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value JKS KeyStore
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Version

      Returns this security provider's version.

      Each security provider's mbean should set the default value of this read-only attribute to a string that specifies the version of the provider (eg. 7.3.04). In other words, each security provider's mbean hard-wires its version. There are no conventions on the contents of the version string.

             
      Privileges Read only
      Typejava.lang.String
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


      Operations

      This section describes the following operations:


      advance

      Advances the list to the next element in the list.

         
      Operation Name"advance"
      ParametersObject [] {  cursor }

      where:

      • cursor is an object of type java.lang.String that specifies:

        - The cursor returned from a previous list method.

      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      aliasExists

      Determines whether or not an alias exists in the registry. Throws InvalidParameterException if alias is empty or null.

         
      Operation Name"aliasExists"
      ParametersObject [] {  alias }

      where:

      • alias is an object of type java.lang.String that specifies:

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

      SignatureString [] { "java.lang.String" }
      Returns boolean

      Exceptions

      close

      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"
      ParametersObject [] {  cursor }

      where:

      • cursor is an object of type java.lang.String that specifies:

        - The cursor returned from a previous list method.

      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      copyToDER

      writes a certificate in the registry to a file in DER binary format. Throws InvalidParameterException if alias or certificateFile is empty or null or if the file cannot be written to.

         
      Operation Name"copyToDER"
      ParametersObject [] {  aliascertificateFile }

      where:

      • alias is an object of type java.lang.String that specifies:

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

      • certificateFile is an object of type java.lang.String that specifies:

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

      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      copyToPEM

      writes a certificate in the registry to a file in PEM base64 encoded format. Throws InvalidParameterException if alias or certificateFile is empty or null or if the file cannot be written to.

         
      Operation Name"copyToPEM"
      ParametersObject [] {  aliascertificateFile }

      where:

      • alias is an object of type java.lang.String that specifies:

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

      • certificateFile is an object of type java.lang.String that specifies:

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

      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      exportData

      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"
      ParametersObject [] {  formatfilenameconstraints }

      where:

      • format is an object of type java.lang.String that specifies:

        - The format for exporting provider specific data.

      • filename is an object of type java.lang.String that specifies:

        - The full path to the filename used to write data.

      • constraints is an object of type java.util.Properties that specifies:

        - The constraints to be used when exporting data. A null value indicates that all data will be exported.

      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void

      Exceptions

      getCertificate

      Retrieves a certificate from the registry.Throws NotFoundException if alias does not exist in the registry.

         
      Operation Name"getCertificate"
      ParametersObject [] {  alias }

      where:

      • alias is an object of type java.lang.String that specifies:

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

      SignatureString [] { "java.lang.String" }
      ReturnsX509Certificate

      Exceptions

      getCurrentName

      The name of the current item in the list. Returns null if there is no current item.

         
      Operation Name"getCurrentName"
      ParametersObject [] {  cursor }

      where:

      • cursor is an object of type java.lang.String that specifies:

        - The cursor returned from a previous list method.

      SignatureString [] { "java.lang.String" }
      ReturnsString

      Exceptions

      haveCurrent

      Returns true if there are more objects in the list, and false otherwise.

         
      Operation Name"haveCurrent"
      ParametersObject [] {  cursor }

      where:

      • cursor is an object of type java.lang.String that specifies:

        - The cursor returned from a previous list method.

      SignatureString [] { "java.lang.String" }
      Returns boolean

      Exceptions

      importData

      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"
      ParametersObject [] {  formatfilenameconstraints }

      where:

      • format is an object of type java.lang.String that specifies:

        - The format for importing provider specific data.

      • filename is an object of type java.lang.String that specifies:

        - The full path to the filename used to read data.

      • constraints is an object of type java.util.Properties that specifies:

        - The constraints to be used when importing data. A null value indicates that all data will be imported.

      SignatureString [] { "java.lang.String", "java.lang.String", "java.util.Properties" }
      Returns void

      Exceptions

      listAliases

      Lists the registered aliases that match a wild card.Returns a String containing a cursor that may be passed into the NameListerMBean methods to read the list. The getCurrentName method returns the current alias on the list.

         
      Operation Name"listAliases"
      ParametersObject [] {  aliasWildcardmaxToReturn }

      where:

      • aliasWildcard is an object of type java.lang.String that specifies:

        - 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 is an object of type java.lang.Integer that specifies:

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

      SignatureString [] { "java.lang.String", "java.lang.Integer" }
      ReturnsString

      Exceptions

      registerCertificate

      Registers an end certificate in the registry under an alias. Throws InvalidParameterException if the alias or certificateFile is empty or null or if the file does not exist or cannot be read.

         
      Operation Name"registerCertificate"
      ParametersObject [] {  aliascertificateFile }

      where:

      • alias is an object of type java.lang.String that specifies:

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

      • certificateFile is an object of type java.lang.String that specifies:

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

      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void

      Exceptions

      unregisterCertificate

      Unregisters an end certificate from the registry. Throws InvalidParameterException if alias is empty or null.

         
      Operation Name"unregisterCertificate"
      ParametersObject [] {  alias }

      where:

      • alias is an object of type java.lang.String that specifies:

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

      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions

      wls_getDisplayName

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString