BEA WebLogic Server 9.0 API Reference

weblogic.security.spi
Interface SecurityProvider

All Known Subinterfaces:

AdjudicationProvider, AdjudicationProviderV2, AuditProvider, AuthenticationProvider, AuthenticationProviderV2, AuthorizationProvider, CertPathProvider, CredentialProvider, CredentialProviderV2, DeployableAuthorizationProvider, DeployableAuthorizationProviderV2, DeployableCredentialProvider, DeployableRoleProvider, DeployableRoleProviderV2, RoleProvider, VersionableApplicationProvider

public interface SecurityProvider

The SecurityProvider interface is required of all security providers (WebLogic and custom) because it provides basic methods for their use in the WebLogic Server environment.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary

String	getDescription() Gets a brief text description of the security provider.
void	initialize(ProviderMBean providerMBean, SecurityServices securityServices) Initializes the security provider.
void	shutdown() Shuts down the security provider.

Method Detail

getDescription

public String getDescription()

Gets a brief text description of the security provider. For example, "Weblogic Authentication provider, version 1.0".

Returns:

a String describing this security provider.

initialize

public void initialize(ProviderMBean providerMBean,
                       SecurityServices securityServices)

Initializes the security provider.

Parameters:

providerMBean - the MBean specific to the security provider that is used during initialization.

securityServices - an object from which a security provider can get the AuditorService, which limits the security provider to using the Auditor object's writeEvent method.

Throws:

SecurityException - if the caller lacks appropriate permission for the operation.

shutdown

public void shutdown()

Shuts down the security provider.

Throws:

SecurityException - if the caller lacks appropriate permission for the operation.