CCOW Web Context Participant Responsibilities

CCOW Web Context Participant Responsibilities

• Locating the Context Management Registry:

  The ContextManagementRegistry interface contains the Locate method. Use the method to locate CCOW components.

  For example, to locate the context manager component:

  var registryData = contextManagementRegistry.locate("CCOW.ContextManager", "1.5", null, clientUrl);

  This method returns LocateData, which contains the following properties:

  • componentUrl (Context Manager URL)
  • componentParameters
  • site (Domain Name)

• Activating\Creating a Context Session:

  The ContextSession interface supports the following operations:

  1. Activating a Context Session

     Activates a context manager so that it represents the active session for a point-of-use device.

  2. Creating a Context Session

     Instructs the context manager to create a new context manager.

     Note: A new session deactivates the current session, allowing users to share the same session.

• Joining a Context Session:

  To join a common context session, create a Context Manager object, and call the JoinCommonContext method.

  Calling JoinCommonContext returns a participant coupon, which is an integer number assigned by the context manager to the application when the application joins a common context session. This coupon is subsequently used by the application to identify itself when it calls a context manager method that requires application identification.

  Note: Setting survey to true when joining the common context means the application will participate in context change surveys. If survey is false, the application will only be informed when a context change has been accepted.

• Suspending\Resuming a Context Participant:

  To suspend an active participation in a common context session while remaining registered as a participant, call the ContextManager.SuspendParticipation

  To resume a suspended participation in a common context session, call the ContextManager.ResumeParticipation method.

• Leaving the Context Session:

  To disconnect the application from the context session, call the ContextManager.LeaveCommonContext method.

  Notes:

  • To Log off an application: To leave the common context session call the ContextManager.LeaveCommonContext method.

  • To Log off all applications (only valid if the signon was performed with SSO enabled): To log off all of the applications that signed onto the common context with SSO enabled, set a logon subject item in the common context with an empty value.

• Getting/Setting the Context Change:

  The ContextData class is used by applications to get/set the data items that comprise the common context.

  The ContextData class contains the following methods:

  1. GetItemNames: Gets the names of common subject context items in the context.
  2. GetItemValues: Gets the value of one or more common subject context items.
  3. SetItemValues: Sets the value of one or more common subject context items.

Note: For secure data use the SecureContextData class instead.