Oracle Fusion Middleware
Oracle WebLogic SIP Server API Reference
11g Release 1 (10.3.4)

Part Number E17873-02

com.bea.wcp.profile
Interface ProfileService

All Known Subinterfaces:
ProfileServiceSpi
All Known Implementing Classes:
ProfileServiceSpiImplBase, ShProviderCached

public interface ProfileService

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

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


Field Summary
static java.lang.String PROFILE_SERVICE
          The string to be used to look up the ProfileService in the ServletContext attributes
 
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.
 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.
 

Field Detail

PROFILE_SERVICE

static final java.lang.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

org.w3c.dom.Document getDocument(java.lang.String docSel)
                                 throws ProfileException
Get a document.

Parameters:
docSel - the document selector to use
Returns:
the Document
Throws:
ProfileException

getDocument

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

Parameters:
requestor - the party making the request
docSel - the Document
Returns:
the Document retrieved
Throws:
ProfileException

putDocument

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

Parameters:
docSel - the document selector to use
doc - the Document to update
Throws:
ProfileException

putDocument

void putDocument(Address requestor,
                 java.lang.String docSel,
                 org.w3c.dom.Document doc)
                 throws ProfileException
Update 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(java.lang.String docSel)
                    throws ProfileException
Delete a document.

Parameters:
docSel - the document selector to use
Throws:
ProfileException

deleteDocument

void deleteDocument(Address requestor,
                    java.lang.String docSel)
                    throws ProfileException
Delete a document.

Parameters:
requestor - the party ordering the delete
docSel - the document selector to use
Throws:
ProfileException

subscribe

ProfileSubscription subscribe(SipApplicationSession session,
                              java.lang.String docSel,
                              java.io.Serializable info)
                              throws ProfileException
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.

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(Address subscriber,
                              SipApplicationSession session,
                              java.lang.String docSel,
                              java.io.Serializable info)
                              throws ProfileException
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.

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(SipApplicationSession session,
                              java.lang.String docSel,
                              int duration,
                              java.io.Serializable info)
                              throws ProfileException
Subscribe 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(Address subscriber,
                              SipApplicationSession session,
                              java.lang.String docSel,
                              int duration,
                              java.io.Serializable info)
                              throws ProfileException
Subscribe 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

Copyright 1996, 2010, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic SIP Server API Reference
11g Release 1 (10.3.4)

Part Number E17873-02