weblogic.management.security

Interface ProviderMBean

All Superinterfaces:

DescriptorBean, SettableBean, StandardInterface

All Known Subinterfaces:

AdjudicatorMBean, ApplicationVersionerMBean, AuditorMBean, AuthenticationProviderMBean, AuthenticatorMBean, AuthorizerMBean, CertPathBuilderMBean, CertPathProviderMBean, CertPathValidatorMBean, CredentialMapperMBean, DeployableAuthorizerMBean, DeployableCredentialMapperMBean, DeployableRoleMapperMBean, IdentityAsserterMBean, KeyStoreMBean, PasswordValidatorMBean, RoleMapperMBean, ServletAuthenticationFilterMBean

public interface ProviderMBean
extends StandardInterface, DescriptorBean

The base MBean for all security providers.

It includes attributes common to all security providers. Every security provider must implement an MBean that extends this MBean.

If the security provider supports management methods, the management methods cannot be called until the validate method of realm in which the security provider is configured successfully returns. That is, the administrator must completely configure the realm before using the management methods (for example, adding a user).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCompatibilityObjectName()
java.lang.String	getDescription() Returns a description of this security provider.
java.lang.String	getName() The name of this configuration.
java.lang.String	getProviderClassName() Returns the name of the Java class used to load this security provider.
RealmMBean	getRealm() Returns the realm that contains this security provider.
java.lang.String	getVersion() Returns this security provider's version.
void	setName(java.lang.String value)

Methods inherited from interface weblogic.management.commo.StandardInterface

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

getProviderClassName

java.lang.String getProviderClassName()

Returns the name of the Java class used to load this security provider.

Each security provider must implement a runtime class (e.g. com.acme.MyAuthenticationProviderImpl) which extends provider type specific interface in weblogic.security.spi (e.g. weblogic.security.spi.AuthorizationProvider).

The security provider must also implement an MBean which ultimately extends this MBean. The security provider's MBean must set the default value of this read-only attribute the fully qualified classname of the security provider's runtime class (e.g. com.acme.MyAuthenticationProviderImpl). In other words, the security provider's MBean hard-wires the name of its runtime class.

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

getDescription

java.lang.String getDescription()

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.

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

getVersion

java.lang.String getVersion()

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.

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

getRealm

RealmMBean getRealm()

Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

getName

java.lang.String getName()

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface StandardInterface

Default Value:

"Provider"

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setName

void setName(java.lang.String value)
      throws javax.management.InvalidAttributeValueException

Specified by:

setName in interface StandardInterface

Throws:

javax.management.InvalidAttributeValueException

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).

getCompatibilityObjectName

java.lang.String getCompatibilityObjectName()

Excluded in public API Reference.

Excluded in public API Reference (Marked as @internal).