The CertificateRegistryMBean is used to configure and manage the Certificate registry.
It is both a builder and a validator. It supports building from the end certificate, the end certificate's subject dn, the end certificate's issuer DN and serial number, and the end certificate's subject key identifier.
| 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.pk.CertificateRegistryMBean
|
||
| 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.
|
|
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:
The certificate registry's description.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | Certificate Registry |
| 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 | CertificateRegistry |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The name of the Java class used to load the certificate registry.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | weblogic.security.providers.pk.CertificateRegistryRuntimeImpl |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
No description provided.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | com.bea.contextelement.security.CertificateGroup |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
No description provided.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | JKS KeyStore Group JKS KeyStore |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
No description provided.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | com.bea.contextelement.security.CertificateGroup |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
No description provided.
| Privileges | Read only |
| Type | class java.lang.String[] |
| Default Value | Group JKS KeyStore JKS KeyStore |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The certificate registry's version.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | 1.0 |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Add an already registered end certificate to list of trust groups.
Throws ErrorCollectionException containing any errors when register the certificate to a single trust group.
Throws InvalidParameterException if the trust groups, alias or certificateFile is empty or null or if the file does not exist or cannot be read.
Throws NotFoundException when the given alias does not exist in the registry.
| Operation Name | "addCertificateToTrustGroups" |
| Parameters | Object [] { trustGroups, alias }
where:
|
| Signature | String [] {
"[Ljava.lang.String;",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
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 |
|
Determines whether or not an alias exists in a trust group.
Return true if the alias exists in the trust group otherwise return false.
Throws InvalidParameterException if the alias or trust group is empty or null.
| Operation Name | "aliasExists" |
| Parameters | Object [] { trustGroup, alias }
where:
|
| Signature | String [] {
"java.lang.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 |
|
Register all certificates contained in a JKS file to a trust group.
Throws InvalidParameterException if the trust group or certificateFile is empty or null or if the file cannot be written to.
Throws NotFoundException if the trust group does not exist in the registry.
Throws ErrorCollectionException if errors happen when register any certificate to the group.
| Operation Name | "copyFromJKS" |
| Parameters | Object [] { trustGroup, certificateFile }
where:
|
| Signature | String [] {
"java.lang.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 a trust group to a file in DER binary format.
Throws InvalidParameterException if the trust group, alias or certificateFile is empty or null or if the file cannot be written to.
Throws NotFoundException if the certificate does not exist in the trust group
| Operation Name | "copyToDER" |
| Parameters | Object [] { trustGroup, alias, certificateFile }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
writes all certificates in a trust group to a JKS.
Throws InvalidParameterException if the trust group or certificateFile is empty or null or if the file cannot be written to.
Throws NotFoundException if the trust group does not exist in the registry.
Throws ErrorCollectionException if errors happen when write any certificate to the JKS file.
| Operation Name | "copyToJKS" |
| Parameters | Object [] { trustGroup, JKSFile }
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 |
|
writes a certificate in a trust group to a file in PEM base64 encoded format.
Throws InvalidParameterException if the trust group, alias or certificateFile is empty or null or if the file cannot be written to.
Throws NotFoundException if the certificate does not exist in the trust group
| Operation Name | "copyToPEM" |
| Parameters | Object [] { trustGroup, alias, certificateFile }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Create an empty trust group in the registry.
Throws AlreadyExistsException if the trust group already registered to the registry.
Throws InvalidParameterException if the trust group is empty or null.
| Operation Name | "createTrustGroup" |
| Parameters | Object [] { TrustGroup }
where:
|
| Signature | 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 |
|
Retrieves a certificate from the registry.
Throws NotFoundException if alias does not exist in the registry.
Throws InvalidParameterException if the alias or trust group is null or empty.
| Operation Name | "getCertificate" |
| Parameters | Object [] { trustGroup, alias }
where:
|
| Signature | String [] {
"java.lang.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 |
|
Retrieves all the trust groups that has a given alias registered under.
Throws NotFoundException if alias does not exist in the registry.
Throws InvalidParameterException if the alias is null or empty.
| Operation Name | "getTrustGroups" |
| Parameters | Object [] { alias }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
class |
| 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 |
|
Determines whether or not an alias was registered in the registry.
Return true if the alias exists in the registry otherwise return false.
Throws InvalidParameterException if the alias is empty or null.
| Operation Name | "isAliasRegistered" |
| Parameters | Object [] { alias }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
| Operation Name | "isSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| 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 |
|
Lists the registered aliases that match a wild card in a given trust group.
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.
Throws InvalidCursorException.
Throws InvalidParameterException if the trust group or wild card is empty or null.
| Operation Name | "listAliasesByTrustGroup" |
| Parameters | Object [] { trustGroup, aliasWildcard, maxToReturn }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Lists the registered trust groups 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 trust group on the list.
Throws InvalidCursorException.
Throws InvalidParameterException if the trust group is empty or null.
| Operation Name | "listTrustGroups" |
| Parameters | Object [] { trustGroupWildcard, 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 |
|
Registers an end certificate from a file in to a list of trust group under an alias.
Throws ErrorCollectionException containing any errors when register the certificate to a trust group.However, the certificate is registered to other trust group.
Throws InvalidParameterException if the trust groups, alias or certificateFile is empty or null or if the file does not exist or cannot be read.
| Operation Name | "registerCertificate" |
| Parameters | Object [] { trustGroups, alias, certificateFile }
where:
|
| Signature | String [] {
"[Ljava.lang.String;",
"java.lang.String",
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Remove an end certificate from the registry which means it is also unregistered from trust groups (if any).
Throws InvalidParameterException if alias is empty or null.
Throws NotFoundException if the alias does not found in the registry.
| Operation Name | "removeCertificate" |
| Parameters | Object [] { alias }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Remove an trust group from the registry.
Throws NotFoundException if the trust group does not exist in the registry.
Throws InvalidParameterException if the trust group is empty or null.
| Operation Name | "removeTrustGroup" |
| Parameters | Object [] { trustGroup }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Determines whether or not a trust group exists in the registry.
Return true if the trust group exists in the registry otherwise return false.
Throws InvalidParameterException if the trust group is empty or null.
| Operation Name | "trustGroupExists" |
| Parameters | Object [] { trustGroup }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
Unregisters an end certificate from trust groups.
Throws InvalidParameterException if alias is empty or null or the given trust groups is empty or null.
Throws ErrorCollectionException if the alias does not found in any of the trust group given. However, the certificate is unregistered from other trust groups.
| Operation Name | "unregisterCertificate" |
| Parameters | Object [] { trustGroups, alias }
where:
|
| Signature | String [] {
"[Ljava.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 |
|
Restore the given property to its default value.
| Operation Name | "unSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Returns the display name of an MBean.
Deprecated 9.0.0.0
| Operation Name | "wls_getDisplayName" |
| Parameters | null |
| Signature | null |
| Returns | String
|