Class Index | File Index

Classes


Class Security.ClientId

A class which provides a Fabric client identification information. Use HTTPFabricConnection#getClientId method to get 'Security.ClientId' object for the current http-client.
Defined in: <D:\Programs\Neeve\Projects\NeeveBuild\stjsapi/src/main/webapp/js\security\ClientId.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Security.ClientId(stringForm)
Stores identification information for a Fabric client.
Method Summary
Method Attributes Method Name and Description
void 
add(name, value)
Adds a new property for the client with the specified name and value
void 
Clears all the fields in the client id
String 
get(name)
Returns the specified property value
String 
Returns the domain name of the client
String 
Returns the login name of the client
String 
Returns the organization unit of the client
String 
Returns the resource name of the client
void 
remove(name)
Removes the specified property of the client id
void 
setDomain(domain)
Sets a domain name for the client
void 
setName(name)
Sets a new name for the client
void 
Sets an organization unit for the client
void 
setResource(resource)
Sets a resource name for the client
String 
Returns the string representation of the client id in the following format <name>@<domain>,ou=<organizationUnit>, resource=<resource>,<name1>=<value1>,.
Class Detail
Security.ClientId(stringForm)
Stores identification information for a Fabric client. Client id is created from the string specified in the format: <userName>@<domain>,ou=<organizationUnit>, resource=<resource>,<name1>=<value1>,...
Parameters:
{String} stringForm
The client id in the string form
Method Detail
add(name, value)
Adds a new property for the client with the specified name and value
Parameters:
{String} name
The name of the property to be added for this client
{String} value
The value of the property to be added for this client

clear()
Clears all the fields in the client id

{String} get(name)
Returns the specified property value
Parameters:
{String} name
The name of the property which value should be returned
Returns:
The specified property value

{String} getDomain()
Returns the domain name of the client
Returns:
This client domain name

{String} getName()
Returns the login name of the client
Returns:
This client login

{String} getOrganizationUnit()
Returns the organization unit of the client
Returns:
This client organization unit

{String} getResource()
Returns the resource name of the client
Returns:
This client resource name

remove(name)
Removes the specified property of the client id
Parameters:
{String} name
The name of the property to be removed from the client id

setDomain(domain)
Sets a domain name for the client
Parameters:
{String} domain
The domain name to be set for this client

setName(name)
Sets a new name for the client
Parameters:
{String} name
The new name to be set for this client

setOrganizationUnit(unit)
Sets an organization unit for the client
Parameters:
{String} unit
The organization unit to be set for the client

setResource(resource)
Sets a resource name for the client
Parameters:
{String} resource
The resource name to be set for this client

{String} toString()
Returns the string representation of the client id in the following format <name>@<domain>,ou=<organizationUnit>, resource=<resource>,<name1>=<value1>,...
Returns:
The client id string representation

Copyright © 2015-2021 StreamScape Technologies. All rights reserved.