oracle.sdp.parlayx.presence.supplier
Class PresenceSupplierClient

java.lang.Object
  oracle.sdpinternal.parlayx.ParlayXClientBase
      oracle.sdp.parlayx.presence.supplier.PresenceSupplierClient

All Implemented Interfaces:

PresenceSupplier

public class PresenceSupplierClient
extends oracle.sdpinternal.parlayx.ParlayXClientBase
implements PresenceSupplier

Constructor Summary

PresenceSupplierClient(Map<java.lang.String,java.lang.Object> parameters)
Construct a client capable of invoking a Parlay X PresenceSupplier webservice.

Method Summary

void	blockSubscription(java.lang.String watcher) This method is implemented per Parlay X 2.1 specification.
List<java.lang.String>	getMyWatchers() This method is implemented per Parlay X 2.1 specification.
List<SubscriptionRequest>	getOpenSubscriptions() This method is implemented per Parlay X 2.1 specification.
PresenceSupplier	getPort()
List<PresenceAttributeType>	getSubscribedAttributes(java.lang.String watcher) This method is implemented as specified in Parlay X 2.1 specification with the following Oracle Extension Currently, only OtherValue and ActivityValue is supported. To terminate a publication, pass in the OtherValue("Expires",0) as a PresenceAttribute in the parameter presence To publish a device note, pass in the OtherValue("DeviceNote",note) as a PresenceAttribute in the parameter presence To publish a service note, pass in the OtherValue("ServiceNote",note) as a PresenceAttribute in the parameter presence
void	publish(List<PresenceAttribute> presence) delegate all operations to the underlying implementation class.
void	updateSubscriptionAuthorization(java.lang.String watcher, List<PresencePermission> decisions) This method is implemented per Parlay X 2.1 specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

PresenceSupplierClient

public PresenceSupplierClient(Map<java.lang.String,java.lang.Object> parameters)

Construct a client capable of invoking a Parlay X PresenceSupplier webservice. The client is configured via a Map of name-object pairs. Any parameters specified will be passed through to the JAX-WS RequestContext. Thus, any key names specified in the JAX-WS documentation are valid, such as BindingProvider.ENDPOINT_ADDRESS_PROPERTY, BindingProvider.SESSION_MAINTAIN_PROPERTY, etc. Key names from class oracle.sdp.parlayx.ParlayXConstants may also be useful.

Parameters:

parameters - A Map of configuration parameters for the client. The values in this map will be passed through to the JAX-WS RequestContext as described above.

Method Detail

blockSubscription

public void blockSubscription(java.lang.String watcher)
                       throws PolicyException,
                              ServiceException

This method is implemented per Parlay X 2.1 specification.

Specified by:

blockSubscription in interface PresenceSupplier

Parameters:

watcher - Watcher that you want to put on the block list.

Throws:

java.rmi.RemoteException

ServiceException

PolicyException

PolicyException

ServiceException

getMyWatchers

public List<java.lang.String> getMyWatchers()
                                     throws PolicyException,
                                            ServiceException

This method is implemented per Parlay X 2.1 specification.

Specified by:

getMyWatchers in interface PresenceSupplier

Returns:

An array of allowed watchers.

Throws:

java.rmi.RemoteException

ServiceException

PolicyException

PolicyException

ServiceException

getOpenSubscriptions

public List<SubscriptionRequest> getOpenSubscriptions()
                                               throws PolicyException,
                                                      ServiceException

This method is implemented per Parlay X 2.1 specification.

Specified by:

getOpenSubscriptions in interface PresenceSupplier

Returns:

An array of pending subscription requests.

Throws:

java.rmi.RemoteException

PolicyException

ServiceException

PolicyException

ServiceException

getPort

public PresenceSupplier getPort()

getSubscribedAttributes

public List<PresenceAttributeType> getSubscribedAttributes(java.lang.String watcher)
                                                    throws PolicyException,
                                                           ServiceException

This method is implemented as specified in Parlay X 2.1 specification with the following Oracle Extension

• Currently, only OtherValue and ActivityValue is supported.
• To terminate a publication, pass in the OtherValue("Expires",0) as a PresenceAttribute in the parameter presence
• To publish a device note, pass in the OtherValue("DeviceNote",note) as a PresenceAttribute in the parameter presence
• To publish a service note, pass in the OtherValue("ServiceNote",note) as a PresenceAttribute in the parameter presence

Specified by:

getSubscribedAttributes in interface PresenceSupplier

Parameters:

presence - An array of presence attributes.

Throws:

java.rmi.RemoteException

PolicyException

ServiceException

PolicyException

ServiceException

publish

public void publish(List<PresenceAttribute> presence)
             throws PolicyException,
                    ServiceException

delegate all operations to the underlying implementation class.

Specified by:

publish in interface PresenceSupplier

Throws:

PolicyException

ServiceException

updateSubscriptionAuthorization

public void updateSubscriptionAuthorization(java.lang.String watcher,
                                            List<PresencePermission> decisions)
                                     throws PolicyException,
                                            ServiceException

This method is implemented per Parlay X 2.1 specification.

Specified by:

updateSubscriptionAuthorization in interface PresenceSupplier

Parameters:

watcher - SIP address of the watcher you want to update its subscription authorization.

decisions - The decision on permission.

Throws:

java.rmi.RemoteException

ServiceException

PolicyException

PolicyException

ServiceException