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:
|
This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.
|
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:
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 governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.
Privileges | Read only |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Privileges | Read only |
Type | java.lang.String |
Default Value | CertRegManager |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A certificate registry always exports all the certificates in the registry thus does not support export constraints.
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. |
A certificate registry exports trusted CAs to a JKS keystore. The keystore must not already exist.
Privileges | Read only |
Type | class java.lang.String[] |
Default Value | JKS KeyStore |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A certificate registry always imports all the certificates in a keystore (identities and trusted CAs) thus does not support export constraints.
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. |
A certificate registry imports trusted CAs from a JKS keystore.
Privileges | Read only |
Type | class java.lang.String[] |
Default Value | JKS KeyStore |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.
Privileges | Read only |
Type | java.lang.String |
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 |
|
Determines whether or not an alias exists in the registry. Throws InvalidParameterException if alias is empty or null.
Operation Name | "aliasExists" |
Parameters | Object [] { alias }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
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 |
|
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" |
Parameters | Object [] { alias, certificateFile }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
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" |
Parameters | Object [] { alias, certificateFile }
where:
|
Signature | String [] {
"java.lang.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 |
|
Retrieves a certificate from the registry.Throws NotFoundException if alias does not exist in the registry.
Operation Name | "getCertificate" |
Parameters | Object [] { alias }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | X509Certificate
|
Exceptions |
|
The name of the current item in the list. Returns null if there is no current item.
Operation Name | "getCurrentName" |
Parameters | Object [] { cursor }
where:
|
Signature | 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 |
|
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" |
Parameters | Object [] { aliasWildcard, maxToReturn }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
Returns | String
|
Exceptions |
|
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" |
Parameters | Object [] { alias, certificateFile }
where:
|
Signature | String [] {
"java.lang.String",
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Unregisters an end certificate from the registry. Throws InvalidParameterException if alias is empty or null.
Operation Name | "unregisterCertificate" |
Parameters | Object [] { alias }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Operation Name | "wls_getDisplayName" |
Parameters | null |
Signature | null |
Returns | String
|