org.apache.avalon.phoenix.metainfo
Class BlockInfo

java.lang.Object
  |
  +--org.apache.avalon.phoenix.metainfo.BlockInfo

public class BlockInfo
extends java.lang.Object

This class contains meta-information of use to administative tools and the kernel. It describes the services offered by a type of block, the dependencies of the block, the management interface of block (if any) and also contains information useful to presenting information in administative screens (like human readable names etc).

Author:
Peter Donald

Constructor Summary
BlockInfo(BlockDescriptor descriptor, ServiceDescriptor[] services, ServiceDescriptor[] managementAccessPoints, DependencyDescriptor[] dependencies)
          Basic constructor that takes as parameters all parts.
 
Method Summary
 BlockDescriptor getBlockDescriptor()
          Return meta information that is generallly only required by administration tools.
 DependencyDescriptor[] getDependencies()
          Return an array of Service dependencies that this Block depends upon.
 DependencyDescriptor getDependency(java.lang.String role)
          Retrieve a dependency with a particular role.
 ServiceDescriptor[] getManagementAccessPoints()
          This returns a list of Services that this block can be Managed by.
 ServiceDescriptor[] getServices()
          This returns a list of Services that this block exports.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BlockInfo

public BlockInfo(BlockDescriptor descriptor,
                 ServiceDescriptor[] services,
                 ServiceDescriptor[] managementAccessPoints,
                 DependencyDescriptor[] dependencies)
Basic constructor that takes as parameters all parts.

Method Detail

getBlockDescriptor

public BlockDescriptor getBlockDescriptor()
Return meta information that is generallly only required by administration tools. It should be loaded on demand and not always present in memory.

Returns:
the BlockDescriptor

getServices

public ServiceDescriptor[] getServices()
This returns a list of Services that this block exports.

Returns:
an array of Services

getManagementAccessPoints

public ServiceDescriptor[] getManagementAccessPoints()
This returns a list of Services that this block can be Managed by.

Returns:
an array of Management Access Points (management services)

getDependencies

public DependencyDescriptor[] getDependencies()
Return an array of Service dependencies that this Block depends upon.

Returns:
an array of Service dependencies

getDependency

public DependencyDescriptor getDependency(java.lang.String role)
Retrieve a dependency with a particular role.

Parameters:
role - the role
Returns:
the dependency or null if it does not exist


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.