com::cosylab::acs::maci::ClientInfo Class Reference

Inheritance diagram for com::cosylab::acs::maci::ClientInfo:

Collaboration diagram for com::cosylab::acs::maci::ClientInfo:

Public Member Functions
	ClientInfo (int handle, String name, Client client)
int	getAccessRights ()
Client	getClient ()
IntArray	getComponents ()
int	getHandle ()
String	getName ()
void	setAccessRights (int accessRights)
void	setClient (Client client)
void	setHandle (int handle)
void	setName (String name)
void	setComponents (IntArray components)
String	toString ()
Private Attributes
int	handle
String	name
Client	client
IntArray	components
int	accessRights
Static Private Attributes
static final long	serialVersionUID = 860176672630128907L

Detailed Description

Structure in which the Manager stores information about a client. Here, a client is any entity that accesses components, and therefore a Component can also act as a client.

Author:: Matej Sekoranja (matej.sekoranja@cosylab.com)

Version:: @VERSION@

Constructor & Destructor Documentation

com::cosylab::acs::maci::ClientInfo::ClientInfo	(	int	handle,
		String	name,
		Client	client
	)			`[inline]`

Creates an instance of ClientInfo with all necesarry data.

Parameters:

	handle	handle of the client.
	name	name of the client.
	client	client itself.

See also:: handle; name; client

References components.

Referenced by com::cosylab::acs::maci::test::ManagerImplSerializationTest::testClientLogin().

Member Function Documentation

int com::cosylab::acs::maci::ClientInfo::getAccessRights ( ) [inline]

Returns the accessRights.

Returns:: int

References accessRights.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::securityCheck().

Client com::cosylab::acs::maci::ClientInfo::getClient ( ) [inline]

Returns the client.

Returns:: Client

References client.

IntArray com::cosylab::acs::maci::ClientInfo::getComponents ( ) [inline]

Returns the components.

Returns:: ArrayList

References components.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::addComponentOwner(), com::cosylab::acs::maci::manager::ManagerImpl::administratorLogout(), com::cosylab::acs::maci::manager::ManagerImpl::clientLogout(), com::cosylab::acs::maci::manager::recovery::ClientInfoCommandComponentRemove::execute(), and com::cosylab::acs::maci::manager::recovery::ClientInfoCommandComponentAdd::execute().

int com::cosylab::acs::maci::ClientInfo::getHandle ( ) [inline]

Returns the handle.

Returns:: int

References handle.

String com::cosylab::acs::maci::ClientInfo::getName ( ) [inline]

Returns the name.

Returns:: String

References name.

void com::cosylab::acs::maci::ClientInfo::setAccessRights ( int accessRights ) [inline]

Sets the accessRights.

Parameters:

accessRights

The accessRights to set

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::administratorLogin(), com::cosylab::acs::maci::manager::ManagerImpl::clientLogin(), and com::cosylab::acs::maci::manager::TimerTaskContainerInfo::createClientInfo().

void com::cosylab::acs::maci::ClientInfo::setClient ( Client client ) [inline]

Sets the client.

Parameters:

client

The client to set

void com::cosylab::acs::maci::ClientInfo::setComponents ( IntArray components ) [inline]

Sets the components.

Parameters:

components

The components to set

Referenced by com::cosylab::acs::maci::manager::TimerTaskContainerInfo::createClientInfo().

void com::cosylab::acs::maci::ClientInfo::setHandle ( int handle ) [inline]

Sets the handle.

Parameters:

handle

The handle to set

void com::cosylab::acs::maci::ClientInfo::setName ( String name ) [inline]

Sets the name.

Parameters:

name

The name to set

String com::cosylab::acs::maci::ClientInfo::toString ( ) [inline]

Returns a single-line rendition of this instance into text.

Returns:: internal state of this instance

References handle, and name.

Member Data Documentation

int com::cosylab::acs::maci::ClientInfo::accessRights [private]

Specifies the access rights of the client. These access rights are used by the Manager in determining the client's access rights.

Referenced by getAccessRights().

Client com::cosylab::acs::maci::ClientInfo::client [private]

Reference to the client's object. If the client is a Component, this is the reference to the Container which hosts the Component.

Referenced by getClient().

IntArray com::cosylab::acs::maci::ClientInfo::components [private]

Specifies the components to which the client has requested and successfuly obtained a reference from the Manager. If a client has done so more than once for the same component, component's handle is repeated.

Referenced by ClientInfo(), and getComponents().

int com::cosylab::acs::maci::ClientInfo::handle [private]

Client's handle. The range depends on the class of the client (a Component, regular client, administrator, ...).

Referenced by getHandle(), and toString().

String com::cosylab::acs::maci::ClientInfo::name [private]

Client's name. This is the same name as given by Client::name for non-Component clients, and Component's name for Component clients.

Referenced by getName(), and toString().

final long com::cosylab::acs::maci::ClientInfo::serialVersionUID = 860176672630128907L [static, private]

Serial version UID.

Reimplemented in com::cosylab::acs::maci::manager::TimerTaskClientInfo.

The documentation for this class was generated from the following file: