Oracle WebLogic Communications Server 10.1 API Reference

com.bea.wcp.profile
Class ProfileServiceSpiImplBase

java.lang.Object
  com.bea.wcp.profile.ProfileServiceSpiImplBase

All Implemented Interfaces:

ProfileService, ProfileServiceSpi

public class ProfileServiceSpiImplBase

extends java.lang.Object

implements ProfileServiceSpi

This is blank implementation of ProfileServiceSpi, used for testing and development purposes. It provides debug output if wlss.Profile debug is turned on.

Copyright © 2008 Oracle Corp. All Rights Reserved.

Field Summary

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

PROFILE_SERVICE

Constructor Summary

ProfileServiceSpiImplBase()

Method Summary

void	deleteDocument(Address requestor, java.lang.String docSel) Delete a document.
void	deleteDocument(java.lang.String docSel) Delete a document.
org.w3c.dom.Document	getDocument(Address requestor, java.lang.String docSel) Get a document.
org.w3c.dom.Document	getDocument(java.lang.String docSel) Get a document.
void	putDocument(Address requestor, java.lang.String docSel, org.w3c.dom.Document doc) Update a document.
void	putDocument(java.lang.String docSel, org.w3c.dom.Document doc) Update a document.
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.
ProfileSubscription	subscribe(Address subscriber, SipApplicationSession session, java.lang.String docSel, int duration, java.io.Serializable info) Subscribe to change notifications for a document described by the docSel document selector.
ProfileSubscription	subscribe(Address subscriber, SipApplicationSession session, java.lang.String docSel, java.io.Serializable info) Subscribe to change notifications for a document described by the docSel document selector.
ProfileSubscription	subscribe(SipApplicationSession session, java.lang.String docSel, int duration, java.io.Serializable info) Subscribe to change notifications for a document described by the docSel document selector.
ProfileSubscription	subscribe(SipApplicationSession session, java.lang.String docSel, java.io.Serializable info) Subscribe to change notifications for a document described by the docSel document selector.
void	unregister() This method is called to inform the profile service provider that it is being disconnected from the profile service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileServiceSpiImplBase

public ProfileServiceSpiImplBase()

Method Detail

deleteDocument

public void deleteDocument(Address requestor,
                           java.lang.String docSel)
                    throws ProfileException

Description copied from interface: ProfileService

Delete a document.

Specified by:

deleteDocument in interface ProfileService

Parameters:

requestor - the party ordering the delete

docSel - the document selector to use

Throws:

ProfileException

deleteDocument

public void deleteDocument(java.lang.String docSel)
                    throws ProfileException

Description copied from interface: ProfileService

Delete a document.

Specified by:

deleteDocument in interface ProfileService

Parameters:

docSel - the document selector to use

Throws:

ProfileException

getDocument

public org.w3c.dom.Document getDocument(Address requestor,
                                        java.lang.String docSel)
                                 throws ProfileException

Description copied from interface: ProfileService

Get a document.

Specified by:

getDocument in interface ProfileService

Parameters:

requestor - the party making the request

docSel - the Document

Returns:

the Document retrieved

Throws:

ProfileException

getDocument

public org.w3c.dom.Document getDocument(java.lang.String docSel)
                                 throws ProfileException

Description copied from interface: ProfileService

Get a document.

Specified by:

getDocument in interface ProfileService

Parameters:

docSel - the document selector to use

Returns:

the Document

Throws:

ProfileException

putDocument

public void putDocument(Address requestor,
                        java.lang.String docSel,
                        org.w3c.dom.Document doc)
                 throws ProfileException

Description copied from interface: ProfileService

Update a document.

Specified by:

putDocument in interface ProfileService

Parameters:

requestor - the party making the request

docSel - the document selector to use

doc - the Document to update

Throws:

ProfileException

putDocument

public void putDocument(java.lang.String docSel,
                        org.w3c.dom.Document doc)
                 throws ProfileException

Description copied from interface: ProfileService

Update a document.

Specified by:

putDocument in interface ProfileService

Parameters:

docSel - the document selector to use

doc - the Document to update

Throws:

ProfileException

register

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

Description copied from interface: ProfileServiceSpi

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.

Specified by:

register in interface ProfileServiceSpi

Parameters:

bean - Configuration bean; use for initialization.

Throws:

ProfileException

subscribe

public ProfileSubscription subscribe(Address subscriber,
                                     SipApplicationSession session,
                                     java.lang.String docSel,
                                     int duration,
                                     java.io.Serializable info)
                              throws ProfileException

Description copied from interface: ProfileService

Subscribe to change notifications for a document described by the docSel document selector. The subscription lasts for duration seconds.

Specified by:

subscribe in interface ProfileService

Parameters:

subscriber - The party making the subscription.

session - The session interested in this subscription

docSel - The document Selector

duration - The length of the subscription in seconds

info - Extra information to be passed in the callback.

Returns:

the new ProfileSubscription

Throws:

ProfileException

subscribe

public ProfileSubscription subscribe(Address subscriber,
                                     SipApplicationSession session,
                                     java.lang.String docSel,
                                     java.io.Serializable info)
                              throws ProfileException

Description copied from interface: ProfileService

Subscribe to change notifications for a document described by the docSel document selector. The subscription is assumed to run forever. This is delegated to the subscribe method.

Specified by:

subscribe in interface ProfileService

Parameters:

subscriber - the party making the subscription

session - The session interested in this subscription

docSel - The document Selector

info - Extra information to be passed in the callback.

Throws:

ProfileException

subscribe

public ProfileSubscription subscribe(SipApplicationSession session,
                                     java.lang.String docSel,
                                     int duration,
                                     java.io.Serializable info)
                              throws ProfileException

Description copied from interface: ProfileService

Subscribe to change notifications for a document described by the docSel document selector. The subscription lasts for duration seconds.

Specified by:

subscribe in interface ProfileService

Parameters:

session - The session interested in this subscription

docSel - The document Selector

duration - The length of the subscription in seconds

info - Extra information to be passed in the callback.

Returns:

the new ProfileSubscription

Throws:

ProfileException

subscribe

public ProfileSubscription subscribe(SipApplicationSession session,
                                     java.lang.String docSel,
                                     java.io.Serializable info)
                              throws ProfileException

Description copied from interface: ProfileService

Subscribe to change notifications for a document described by the docSel document selector. The subscription is assumed to run forever. This is delegated to the subscribe method.

Specified by:

subscribe in interface ProfileService

Parameters:

session - The session interested in this subscription

docSel - The document Selector

info - Extra information to be passed in the callback.

Throws:

ProfileException

unregister

public void unregister()

Description copied from interface: ProfileServiceSpi

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.

Specified by:

unregister in interface ProfileServiceSpi