com.bea.wcp.profile

Interface ProfileService

All Known Subinterfaces:

ProfileServiceSpi

All Known Implementing Classes:

ProfileServiceCached, ProfileServiceSpiImplBase, WlssProfileService

public interface ProfileService

Starting point for accessing the Profile service. The ProfileService is stored as an attribute of the ServletContext. For example in a Servlet, the following example illustrates how to obtain a reference to the service:

 ProfileService psvc = (ProfileService) getServletContext().getAttribute(ProfileService.PROFILE_SERVICE);
 

Author:

Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROFILE_SERVICE The string to be used to look up the ProfileService in the ServletContext attributes.

Method Summary

Modifier and Type	Method and Description
void	deleteDocument(javax.servlet.sip.Address requestor, String docSel) Deletes a document.
void	deleteDocument(String docSel) Deletes a document.
Document	getDocument(javax.servlet.sip.Address requestor, String docSel) Gets a document.
Document	getDocument(String docSel) Gets a document.
void	putDocument(javax.servlet.sip.Address requestor, String docSel, Document doc) Updates a document.
void	putDocument(String docSel, Document doc) Updates a document.
ProfileSubscription	subscribe(javax.servlet.sip.Address subscriber, javax.servlet.sip.SipApplicationSession session, String docSel, int duration, Serializable info) Subscribes to change notifications for a document described by the docSel document selector.
ProfileSubscription	subscribe(javax.servlet.sip.Address subscriber, javax.servlet.sip.SipApplicationSession session, String docSel, Serializable info) Subscribes to change notifications for a document described by the docSel document selector.
ProfileSubscription	subscribe(javax.servlet.sip.SipApplicationSession session, String docSel, int duration, Serializable info) Subscribes to change notifications for a document described by the docSel document selector.
ProfileSubscription	subscribe(javax.servlet.sip.SipApplicationSession session, String docSel, Serializable info) Subscribes to change notifications for a document described by the docSel document selector.

Field Detail

PROFILE_SERVICE

static final String PROFILE_SERVICE

The string to be used to look up the ProfileService in the ServletContext attributes.

See Also:

Constant Field Values

Method Detail

getDocument

Document getDocument(String docSel)
              throws ProfileException

Gets a document.

Parameters:

docSel - the document selector to use

Returns:

the Document

Throws:

ProfileException

getDocument

Document getDocument(javax.servlet.sip.Address requestor,
                     String docSel)
              throws ProfileException

Gets a document.

Parameters:

requestor - the party making the request

docSel - the Document

Returns:

the Document retrieved

Throws:

ProfileException

putDocument

void putDocument(String docSel,
                 Document doc)
          throws ProfileException

Updates a document.

Parameters:

docSel - the document selector to use

doc - the Document to update

Throws:

ProfileException

putDocument

void putDocument(javax.servlet.sip.Address requestor,
                 String docSel,
                 Document doc)
          throws ProfileException

Updates a document.

Parameters:

requestor - the party making the request

docSel - the document selector to use

doc - the Document to update

Throws:

ProfileException

deleteDocument

void deleteDocument(String docSel)
             throws ProfileException

Deletes a document.

Parameters:

docSel - the document selector to use

Throws:

ProfileException

deleteDocument

void deleteDocument(javax.servlet.sip.Address requestor,
                    String docSel)
             throws ProfileException

Deletes a document.

Parameters:

requestor - the party ordering the delete

docSel - the document selector to use

Throws:

ProfileException

subscribe

ProfileSubscription subscribe(javax.servlet.sip.SipApplicationSession session,
                              String docSel,
                              Serializable info)
                       throws ProfileException

Subscribes 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.

Parameters:

session - The session interested in this subscription

docSel - The document Selector

info - Extra information to be passed in the callback

Throws:

ProfileException

subscribe

ProfileSubscription subscribe(javax.servlet.sip.Address subscriber,
                              javax.servlet.sip.SipApplicationSession session,
                              String docSel,
                              Serializable info)
                       throws ProfileException

Subscribes 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.

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

ProfileSubscription subscribe(javax.servlet.sip.SipApplicationSession session,
                              String docSel,
                              int duration,
                              Serializable info)
                       throws ProfileException

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

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

ProfileSubscription subscribe(javax.servlet.sip.Address subscriber,
                              javax.servlet.sip.SipApplicationSession session,
                              String docSel,
                              int duration,
                              Serializable info)
                       throws ProfileException

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

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