com.bea.wcp.profile
Interface ProfileServiceSpi

All Superinterfaces:

ProfileService

All Known Implementing Classes:

ProfileServiceSpiImplBase, ShProviderCached

public interface ProfileServiceSpi
extends ProfileService

Interface to be implemented by a provider. Profile service providers must be registered in the profile.xml configuration file.

It is acceptable for a provider to implement only a subset of the ProfileService methods. In that case, the unimplemented ones should throw OperationNotSupportedException.

See Also:

ProfileService

Field Summary

Fields inherited from interface com.bea.wcp.profile.ProfileService

PROFILE_SERVICE

Method Summary

void	register(com.bea.wcp.profile.descriptor.beans.ProviderBean bean) This method is called when the profile service attempts to register an instance of this provider.
void	unregister() This method is called to inform the profile service provider that it is being disconnected from the profile service.

Methods inherited from interface com.bea.wcp.profile.ProfileService

deleteDocument, deleteDocument, getDocument, getDocument, putDocument, putDocument, subscribe, subscribe, subscribe, subscribe

Method Detail

register

void register(com.bea.wcp.profile.descriptor.beans.ProviderBean bean)
              throws ProfileException

This method is called when the profile service attempts to register an instance of this provider. The instance should examine the configuration information provider in the ProviderBean, and do whatever is necessary to begin operations. If this is not possible, the provider should throw a ProfileException.

Parameters:

bean - Configuration bean; use for initialization.

Throws:

ProfileException

unregister

void unregister()

This method is called to inform the profile service provider that it is being disconnected from the profile service. This is an opportunity to do whatever state cleanup would be useful. Note that this method is advisory only; it cannot be used to prevent unregistration.