com::cosylab::acs::maci::ComponentInfo Class Reference

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

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

Public Member Functions
	ComponentInfo (int handle, String name, String type, String code, Component component)
int	getContainer ()
IntArray	getClients ()
Component	getComponent ()
int	getHandle ()
String[]	getInterfaces ()
String	getName ()
String	getType ()
String	getCode ()
int	getAccessRights ()
void	setContainer (int container)
void	setComponent (Component component)
void	setHandle (int handle)
void	setInterfaces (String[] interfaces)
void	setName (String name)
void	setType (String type)
void	setCode (String code)
void	setAccessRights (int accessRights)
void	setClients (IntArray clients)
IntArray	getComponents ()
void	setComponents (IntArray components)
String	getContainerName ()
void	setContainerName (String containerName)
String	toString ()
boolean	isDynamic ()
void	setDynamic (boolean b)
String	getDynamicContainerName ()
void	setDynamicContainerName (String string)
int	getKeepAliveTime ()
void	setKeepAliveTime (int keepAliveTime)
int	compareTo (ComponentInfo o)
Private Attributes
int	handle
String	name
String	type
String	code
Component	component
IntArray	clients
IntArray	components
int	container
String	containerName
int	accessRights
String[]	interfaces
boolean	isDynamic
String	dynamicContainerName
int	keepAliveTime
Static Private Attributes
static final long	serialVersionUID = -4376414924118239593L

Detailed Description

Structure in which the Manager (and Container) stores information about a component.

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

Version:: @VERSION@

Constructor & Destructor Documentation

com::cosylab::acs::maci::ComponentInfo::ComponentInfo	(	int	handle,
		String	name,
		String	type,
		String	code,
		Component	component
	)			`[inline]`

Creates an instance of ComponentInfo with all necesarry data.

Parameters:

	handle	handle of the component.
	name	name of the component.
	type	type of the component.
	code	code of the component.
	component	component itself.

See also:: handle; name; type; component

References clients, components, isDynamic(), and keepAliveTime.

Referenced by com::cosylab::acs::maci::plug::ContainerProxy::activate_component(), com::cosylab::acs::maci::plug::ContainerProxy::get_component_info(), and com::cosylab::acs::maci::plug::ManagerProxy::getComponentInfo().

Member Function Documentation

int com::cosylab::acs::maci::ComponentInfo::compareTo ( ComponentInfo o ) [inline]

References name.

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

Returns the accessRights.

Returns:: int

References accessRights.

IntArray com::cosylab::acs::maci::ComponentInfo::getClients ( ) [inline]

Returns the clients.

Returns:: ArrayList

References clients.

String com::cosylab::acs::maci::ComponentInfo::getCode ( ) [inline]

Returns the code.

Returns:: String

References code.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), com::cosylab::acs::maci::manager::ManagerImpl::hasCDBEntry(), com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent(), and com::cosylab::acs::maci::manager::ManagerImpl::internalRequestDefaultComponent().

Component com::cosylab::acs::maci::ComponentInfo::getComponent ( ) [inline]

Returns the component.

Returns:: Component

References component.

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

Get array of component handles that this component requested.

Returns:: array of component handles that this component requested.

References components.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::addComponentOwner(), com::cosylab::acs::maci::manager::ManagerImpl::doCycleCheck(), com::cosylab::acs::maci::manager::recovery::ComponentInfoCommandComponentRemove::execute(), com::cosylab::acs::maci::manager::recovery::ComponentInfoCommandComponentAdd::execute(), com::cosylab::acs::maci::manager::ComponentInfoTopologicalSort::extract(), com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncDeactivateComponent(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

int com::cosylab::acs::maci::ComponentInfo::getContainer ( ) [inline]

Returns the container.

Returns:: int

References container.

String com::cosylab::acs::maci::ComponentInfo::getContainerName ( ) [inline]

Get container name which hosts the component.

Returns:: Returns the container name.

References containerName.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::getCollocatedComponent(), com::cosylab::acs::maci::manager::ManagerImpl::getComponentInfo(), com::cosylab::acs::maci::manager::ComponentInfoTopologicalSortManager::getComponentShutdownOrder(), com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncReleaseComponent(), com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent(), and com::cosylab::acs::maci::manager::ComponentInfoTopologicalSortManager::run().

String com::cosylab::acs::maci::ComponentInfo::getDynamicContainerName ( ) [inline]

Get container on which dynamic component was activated.

Returns:: container on which dynamic component was activated.

References dynamicContainerName.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerPostLoginActivation(), com::cosylab::acs::maci::manager::ManagerImpl::hasCDBEntry(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

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

Returns the handle.

Returns:: int

References handle.

String [] com::cosylab::acs::maci::ComponentInfo::getInterfaces ( ) [inline]

Returns the interfaces.

Returns:: String[]

References interfaces.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), com::cosylab::acs::maci::plug::ManagerProxyImpl::get_component_info(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

int com::cosylab::acs::maci::ComponentInfo::getKeepAliveTime ( ) [inline]

Get component keep alive time.

Returns:: component keep alive time.

References keepAliveTime.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncReleaseComponent(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

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

Returns the name.

Returns:: String

References name.

String com::cosylab::acs::maci::ComponentInfo::getType ( ) [inline]

Returns the type.

Returns:: String

References type.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), com::cosylab::acs::maci::manager::ManagerImpl::getCollocatedComponent(), com::cosylab::acs::maci::manager::ManagerImpl::getComponentInfo(), com::cosylab::acs::maci::manager::ManagerImpl::getDynamicComponent(), com::cosylab::acs::maci::manager::ManagerImpl::hasCDBEntry(), com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent(), com::cosylab::acs::maci::manager::ManagerImpl::internalRequestDefaultComponent(), and com::cosylab::acs::maci::manager::ManagerImpl::registerComponent().

boolean com::cosylab::acs::maci::ComponentInfo::isDynamic ( ) [inline]

Get dynamic flag.

Returns:: dynamic flag.

Referenced by ComponentInfo(), and setDynamic().

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

Sets the access rights.

Parameters:

accessRights

The access rights to set

Referenced by com::cosylab::acs::maci::plug::ContainerProxy::activate_component(), com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), com::cosylab::acs::maci::plug::ContainerProxy::get_component_info(), com::cosylab::acs::maci::plug::ManagerProxy::getComponentInfo(), com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent(), and com::cosylab::acs::maci::manager::ManagerImpl::registerComponent().

void com::cosylab::acs::maci::ComponentInfo::setClients ( IntArray clients ) [inline]

Sets the clients.

Parameters:

clients

The clients to set

Referenced by com::cosylab::acs::maci::plug::ContainerProxy::activate_component(), com::cosylab::acs::maci::plug::ContainerProxy::get_component_info(), com::cosylab::acs::maci::plug::ManagerProxy::getComponentInfo(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

void com::cosylab::acs::maci::ComponentInfo::setCode ( String code ) [inline]

Sets the code.

Parameters:

code

The code to set

void com::cosylab::acs::maci::ComponentInfo::setComponent ( Component component ) [inline]

Sets the component.

Parameters:

component

The component to set

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), and com::cosylab::acs::maci::manager::ManagerImpl::makeUnavailable().

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

Sets the components.

Parameters:

components

The components to set

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

void com::cosylab::acs::maci::ComponentInfo::setContainer ( int container ) [inline]

Sets the container.

Parameters:

container

The container to set

void com::cosylab::acs::maci::ComponentInfo::setContainerName ( String containerName ) [inline]

Set container name.

Parameters:

containerName

The container name to set.

void com::cosylab::acs::maci::ComponentInfo::setDynamic ( boolean b ) [inline]

Set dynamic flag.

Parameters:

b

dynamic flag.

References isDynamic().

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

void com::cosylab::acs::maci::ComponentInfo::setDynamicContainerName ( String string ) [inline]

Set container on which dynamic component was activated.

Parameters:

string

container on which dynamic component was activated.

References dynamicContainerName.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerInternalStateMerge(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

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

Sets the handle.

Parameters:

handle

The handle to set

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

void com::cosylab::acs::maci::ComponentInfo::setInterfaces ( String[] interfaces ) [inline]

Sets the interfaces.

Parameters:

interfaces

The interfaces to set

void com::cosylab::acs::maci::ComponentInfo::setKeepAliveTime ( int keepAliveTime ) [inline]

Set component keep alive time.

Parameters:

keepAliveTime

the keepAliveTime to set.

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

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

Sets the name.

Parameters:

name

The name to set

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

void com::cosylab::acs::maci::ComponentInfo::setType ( String type ) [inline]

Sets the type.

Parameters:

type

The type to set

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

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

Returns:: internal state of this instance

References code, component, container, containerName, handle, name, and type.

Member Data Documentation

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

Required access rights to access this component. When a client attempts to access the component (via Manager's get_component), the bitwise AND of client's access and component's access must yield component's access in order for the client to have the permission to access the component.

Referenced by getAccessRights().

IntArray com::cosylab::acs::maci::ComponentInfo::clients [private]

Specifies the clients that have requested and successfuly obtained a reference to this component from the Manager. If a client has done so more than once, its handle is not repeated. For immortal and startup components this list always contains at least one handle - the Manager. Thus, the only way to deactivate these components is by deactivating the Manager.

Referenced by ComponentInfo(), and getClients().

String com::cosylab::acs::maci::ComponentInfo::code [private]

The code of the component. Path to the executable file (a DLL, a shared library, or Java class name) in which the component's code resides. Can be null, if unknown.

Referenced by getCode(), and toString().

Component com::cosylab::acs::maci::ComponentInfo::component [private]

Reference to the component, null if the component has not yet been activated.

Referenced by getComponent(), and toString().

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

Specifies the components that have been requested and successfuly obtained a reference by this component from the Manager. If a component has done so more than once, its handle is not repeated.

Referenced by ComponentInfo(), and getComponents().

int com::cosylab::acs::maci::ComponentInfo::container [private]

Handle to the container which hosts the component. This handle is 0 if the component has not been activated by an component, but by some other means, and has only been registered with the Manager through register_component.

Referenced by getContainer(), and toString().

String com::cosylab::acs::maci::ComponentInfo::containerName [private]

Name of the container which hosts the component.

Referenced by getContainerName(), and toString().

String com::cosylab::acs::maci::ComponentInfo::dynamicContainerName [private]

Name of the container on which dynamic component was activated. NOTE: this attribute is internal.

Referenced by getDynamicContainerName(), and setDynamicContainerName().

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

Component's handle. The handle is automatically assigned by the Manager.

Referenced by getHandle(), and toString().

String [] com::cosylab::acs::maci::ComponentInfo::interfaces [private]

A list of all interfaces supported by the component. The first interface in the list is the default interface.

Referenced by getInterfaces().

boolean com::cosylab::acs::maci::ComponentInfo::isDynamic [private]

Dynamic component flag. NOTE: this attribute is internal.

Referenced by com::cosylab::acs::maci::manager::ManagerImpl::containerPostLoginActivation(), com::cosylab::acs::maci::manager::ManagerImpl::hasCDBEntry(), and com::cosylab::acs::maci::manager::ManagerImpl::internalNoSyncRequestComponent().

int com::cosylab::acs::maci::ComponentInfo::keepAliveTime [private]

Keep alive time of a component (needed for dynamic components). NOTE: this attribute is internal.

Referenced by ComponentInfo(), and getKeepAliveTime().

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

Name of the component (without the domain). The name of the component must be unique within the domain, and can be used to identify the component. The name can imply hierarchy, which it does by separating name components with a '/' (slash).

Referenced by compareTo(), getName(), and toString().

final long com::cosylab::acs::maci::ComponentInfo::serialVersionUID = -4376414924118239593L [static, private]

Serial version UID.

String com::cosylab::acs::maci::ComponentInfo::type [private]

The type of the component. Uniquely identifies the code-base which the component's servant is executing. Given the type name and a hypothetical type library it is possible to infer supported interfaces, version information, etc.

Referenced by getType(), and toString().

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

CommonSoftware/jmanager/src/com/cosylab/acs/maci/ComponentInfo.java

com::cosylab::acs::maci::ComponentInfo Class Reference

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation