MicroTAPAS
Class SubscribeRequest

java.lang.Object
  |
  +--MicroTAPAS.SubscribeRequest

All Implemented Interfaces:

java.io.Serializable

public class SubscribeRequest

extends java.lang.Object

implements java.io.Serializable

This class specifies the request for subscription interface between the subscription clients and the Subscribe service provider.

See Also:

Serialized Form

Field Summary

static int	ActorBehaviourPlaugOut
static int	ActorBehaviourPlugIn
static int	ActorCapabilities
static int	ActorChangeBehaviour
static int	ActorCreate
static int	ActorMove
static int	ActorPlay
static int	ActorPlugIn
static int	ActorPlugOut
static int	ActorRemove
java.lang.String[]	applType The set of applications that shall be reported.
int[]	eventTypes The set of event types that shall be reported. null means all.
static int	Immediately
static int	Periodically
static int	PlayChangesPlugIn
static int	PlayPlugIn
static int	PlayPlugOut
GAI	requestor Address to client that request for the service, and where the reports will be sent
static int	RoleSessionAction
static int	RoleSessionCreate
static int	RoleSessionRemove
static java.lang.String[]	RT
GAI[]	scope The set of addresses that shall be reported.
static int	SpecifiedTime
static int	SubscribeCancel
static int	SubscribeReport
static int	SubscribeRequest
static int	WhenCancel
int	whenType Specifies when reports shall be given.
java.lang.String	whenValue see 'whenType'.

Constructor Summary

SubscribeRequest(GAI rq, int[] et, GAI[] adr, java.lang.String[] at, int wt, java.lang.String vv)
Build subscription request.

Method Summary

java.lang.String	toString() Convert to textual representation of SubscribeRequest object
static java.lang.String	toString(SubscribeRequest obj) Convert to textual representation of SubscribeRequest object

Methods inherited from class java.lang.Object

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

Field Detail

requestor

public GAI requestor

Address to client that request for the service, and where the reports will be sent

eventTypes

public int[] eventTypes

The set of event types that shall be reported. null means all.

PlayPlugIn

public static final int PlayPlugIn

See Also:

Constant Field Values

PlayChangesPlugIn

public static final int PlayChangesPlugIn

See Also:

Constant Field Values

PlayPlugOut

public static final int PlayPlugOut

See Also:

Constant Field Values

ActorPlugIn

public static final int ActorPlugIn

See Also:

Constant Field Values

ActorPlugOut

public static final int ActorPlugOut

See Also:

Constant Field Values

ActorBehaviourPlugIn

public static final int ActorBehaviourPlugIn

See Also:

Constant Field Values

ActorChangeBehaviour

public static final int ActorChangeBehaviour

See Also:

Constant Field Values

ActorBehaviourPlaugOut

public static final int ActorBehaviourPlaugOut

See Also:

Constant Field Values

ActorPlay

public static final int ActorPlay

See Also:

Constant Field Values

SubscribeRequest

public static final int SubscribeRequest

See Also:

Constant Field Values

SubscribeReport

public static final int SubscribeReport

See Also:

Constant Field Values

SubscribeCancel

public static final int SubscribeCancel

See Also:

Constant Field Values

RoleSessionAction

public static final int RoleSessionAction

See Also:

Constant Field Values

ActorCapabilities

public static final int ActorCapabilities

See Also:

Constant Field Values

ActorCreate

public static final int ActorCreate

See Also:

Constant Field Values

ActorRemove

public static final int ActorRemove

See Also:

Constant Field Values

RoleSessionCreate

public static final int RoleSessionCreate

See Also:

Constant Field Values

RoleSessionRemove

public static final int RoleSessionRemove

See Also:

Constant Field Values

ActorMove

public static final int ActorMove

See Also:

Constant Field Values

RT

public static java.lang.String[] RT

scope

public GAI[] scope

The set of addresses that shall be reported. May be partially specified. null means all.

applType

public java.lang.String[] applType

The set of applications that shall be reported. Not defined yet how this shall be applied

whenType

public int whenType

Specifies when reports shall be given. Immediately: Report when event occur, Periodically: Report periodically with periode specified by 'whenValue' in seconds., SpecifiedTime: Report once, and at specified time specified by 'whenValue' WhenCancel: Report once, when cancel of subscription

Immediately

public static final int Immediately

See Also:

Constant Field Values

Periodically

public static final int Periodically

See Also:

Constant Field Values

SpecifiedTime

public static final int SpecifiedTime

See Also:

Constant Field Values

WhenCancel

public static final int WhenCancel

See Also:

Constant Field Values

whenValue

public java.lang.String whenValue

see 'whenType'.

Constructor Detail

SubscribeRequest

public SubscribeRequest(GAI rq,
                        int[] et,
                        GAI[] adr,
                        java.lang.String[] at,
                        int wt,
                        java.lang.String vv)

Build subscription request.

Parameters:

rq - Address to client that request for the service, and where the reports will be sent.

et - Those that is defined in class 'RequestPars' The set of addresses that shall be reported. May be partially specified. null means all.

adr - The set of applications that shall be reported. Not defined yet how this shall be applied.

wt - Specifies when reports shall be given (see 'whenType').

vv - Specifies time periode or exact time for report (se 'whenType').

Method Detail

toString

public java.lang.String toString()

Convert to textual representation of SubscribeRequest object

Overrides:

toString in class java.lang.Object

Returns:

Textual representation of object

toString

public static java.lang.String toString(SubscribeRequest obj)

Convert to textual representation of SubscribeRequest object

Parameters:

obj - SubscribeRequest object - if existing

Returns:

Textual representation of object