class UserContextManager

Manage contexts, contexts for targets and contexts for URI.

Public Methods

[more] UserContextManager(UCH* uch, string loggedUserContextData, string userName, string password)
Basic Constructor
[more]bool openUserContext(map<string, string>* request, map<string, string>* response, string userName, string password)
Open user context session
[more]void closeUserContext(map<string, string>* request)
Close user Context
[more]list<map<string, IProfile*>*> * getContexts()
Get all Contexts.
[more]map<string, IProfile*> * getContext(map<string, string>*request, string userName, string password)
Get all Contexts for given username and password.
[more]list<map<string, IProfile*>*> * getTargetContexts(string targetId)
Get contexts for specified Target Id.
[more]void targetContextsAdded(string targetId, list<map<string, IProfile*>*>*contexts)
Add specified contexts for specified TargetId.
[more]void targetContextsRemoved(string targetId, list<map<string, IProfile*>*>*contexts)
Remove specified contexts for specified TargetId.
[more]list<string> * getAvailableTargetIds(map<string, IProfile*>* context)
Get available Target Ids for specified context.
[more]void addUriServiceContexts(string uri, list<map<string, IProfile*>*>*contexts)
Add specified contexts for specified URI.
[more]void removeUriServiceContexts(string uri, list<map<string, IProfile*>*>*contexts)
Remove specified contexts for specified URI.
[more]list<string> * getURIs(map<string, IProfile*>* context)
Get a List of URI that allow specified context.
[more]map<string, IProfile*> * getContext(string sessionId)
Get user Context for specified Session Id.
[more]bool validateUser(map<string, string>*request, string userName, string password)
Validate the username and password

Documentation

Manage contexts, contexts for targets and contexts for URI. Every context contains user profile and controller profile.

o UserContextManager(UCH* uch, string loggedUserContextData, string userName, string password)
Basic Constructor
Parameters:
uch - an UCH Object
tdmListener - an TDMListener Object
tdmListener - an TAListener Object
uipmListener - an UIPMListener Object

obool openUserContext(map<string, string>* request, map<string, string>* response, string userName, string password)
Open user context session
Parameters:
request - a HTTP request Map<String, String>
response - a HTTP request Map<String, String>
userName - a String Value of username
password - a String Value of password
Returns:
true if successful else false

ovoid closeUserContext(map<string, string>* request)
Close user Context
Parameters:
sessionId - a String Value of sessionId

olist<map<string, IProfile*>*> * getContexts()
Get all Contexts.

Returns:
an Object of List<Map<String, IProfile>>

omap<string, IProfile*> * getContext(map<string, string>*request, string userName, string password)
Get all Contexts for given username and password.
Parameters:
request - an key-value map of HTTP headers
userName - a String Value of username
password - a String Value of password
Returns:
an Object of Map<String, IProfile>

olist<map<string, IProfile*>*> * getTargetContexts(string targetId)
Get contexts for specified Target Id.

Parameters:
targetId - a String value of Target Id
Returns:
an Object of List<Map<String, IProfile>>

ovoid targetContextsAdded(string targetId, list<map<string, IProfile*>*>*contexts)
Add specified contexts for specified TargetId.

Note : Empty contexts and null contexts has different meaning. If contexts is empty then no user/controller context is allowed to use that Target. If contexts is null then every user/controller context is allowed to use that Target.

Parameters:
targetId - a String value of Target Id
contexts - an Object of List<Map<String, IProfile>>

ovoid targetContextsRemoved(string targetId, list<map<string, IProfile*>*>*contexts)
Remove specified contexts for specified TargetId.

Parameters:
targetId - a String value of Target Id
contexts - an Object of List<Map<String, IProfile>>

olist<string> * getAvailableTargetIds(map<string, IProfile*>* context)
Get available Target Ids for specified context.

Parameters:
context - an Object of Map<String, IProfile>
Returns:
an Object of List<String>

ovoid addUriServiceContexts(string uri, list<map<string, IProfile*>*>*contexts)
Add specified contexts for specified URI.

Note : Empty contexts and null contexts has different meaning. If contexts is empty then no user/controller context is allowed to use that URI. If contexts is null then every user/controller context is allowed to use that URI.

Parameters:
uri - a String value of URI
contexts - an Object of List<Map<String, IProfile>>

ovoid removeUriServiceContexts(string uri, list<map<string, IProfile*>*>*contexts)
Remove specified contexts for specified URI.

Parameters:
uri - a String value of URI
contexts - an Object of List<Map<String, IProfile>>

olist<string> * getURIs(map<string, IProfile*>* context)
Get a List of URI that allow specified context.

Parameters:
context - an Object of Map<String, IProfile>
Returns:
an Object of List<String>

omap<string, IProfile*> * getContext(string sessionId)
Get user Context for specified Session Id.

Parameters:
sessionId - a String value of SessionId
Returns:
an Object of Map<String, IProfile>

obool validateUser(map<string, string>*request, string userName, string password)
Validate the username and password
Parameters:
userName - a String Value of username
password - a String Value of password
Returns:
true if username and password is valid else false

This class has no child classes.
Author:
Parikshit Thakur & Team, Trace R&D Center
Version:
Revision: 1.1

Alphabetic index HTML hierarchy of classes or Java


This page was generated with the help of DOC++.