|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hyperic.hq.product.TypeBuilder
public class TypeBuilder
Simple helper class to help keep plugin entity names
consistent.
This class supports adding one server, and its child services.
This class also supports adding multiple versions of the
same server.
Typically, the plugin developer uses the default
PLATFORM_NAMES
for the list
of platforms supported by a given server. The plugin
developer can specify her own list of supported platforms.
Field Summary | |
---|---|
static java.lang.String[] |
ALL_PLATFORM_NAMES
|
static java.lang.String |
NO_VERSION
Version will be excluded from composed server name. |
static java.lang.String[] |
UNIX_PLATFORM_NAMES
|
static java.lang.String[] |
WIN32_PLATFORM_NAMES
|
Constructor Summary | |
---|---|
TypeBuilder()
|
|
TypeBuilder(java.lang.String serverName,
java.lang.String serverDesc)
Create a server type for use on all supported platforms |
|
TypeBuilder(java.lang.String serverName,
java.lang.String serverDesc,
java.lang.String[] platforms)
use this constructor for specifying a list of supported platforms. |
Method Summary | |
---|---|
boolean |
add(TypeInfo type)
|
PlatformTypeInfo |
addPlatform(java.lang.String name)
|
ServerTypeInfo |
addServer(ServerTypeInfo server,
java.lang.String[] platforms)
Add a ServerTypeInfo clone of the given server, changing valid platforms to the given platforms. |
ServerTypeInfo |
addServer(java.lang.String version)
This method creates a ServerTypeInfo and adds this object to the entity list using a version string. |
ServerTypeInfo |
addServer(java.lang.String name,
java.lang.String version)
This method creates a ServerTypeInfo and adds this object to the entity list using a version string. |
ServerTypeInfo |
addServer(java.lang.String name,
java.lang.String version,
java.lang.String[] platforms)
|
ServerTypeInfo |
addServerAndServices(ServerTypeInfo server,
java.lang.String[] platforms)
Add a ServerTypeInfo clone of the given server, changing valid platforms to the given platforms. |
ServiceTypeInfo |
addService(ServerTypeInfo server,
java.lang.String name)
This method creates a deployed (non-internal) ServiceTypeInfo object and adds it services to the entity list |
void |
addServices(ServerTypeInfo fromServer,
ServerTypeInfo toServer)
Clone all services from an existing server. |
void |
addServices(ServerTypeInfo server,
java.lang.String[] services)
This method adds a list of services to the this.entity list. |
void |
addServices(ServerTypeInfo server,
java.lang.String[] deployedServices,
java.lang.String[] internalServices)
This method adds a list of internal and deployed services to the this.entity. |
static java.lang.String |
composePlatformTypeName(java.lang.String name,
java.lang.String platformName)
|
static java.lang.String |
composeServerTypeName(java.lang.String name,
java.lang.String version)
|
static java.lang.String |
composeServiceTypeName(java.lang.String serverName,
java.lang.String serviceName)
Given a serverName and a serviceName, return the name of the service type. |
TypeInfo[] |
getTypes()
This method returns a list of server/service added to this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NO_VERSION
public static final java.lang.String[] ALL_PLATFORM_NAMES
public static final java.lang.String[] WIN32_PLATFORM_NAMES
public static final java.lang.String[] UNIX_PLATFORM_NAMES
Constructor Detail |
---|
public TypeBuilder()
public TypeBuilder(java.lang.String serverName, java.lang.String serverDesc)
serverName
- name of the serverserverDesc
- server descriptionpublic TypeBuilder(java.lang.String serverName, java.lang.String serverDesc, java.lang.String[] platforms)
serverName
- name of the serverserverDesc
- server descriptionMethod Detail |
---|
public PlatformTypeInfo addPlatform(java.lang.String name)
public ServerTypeInfo addServer(java.lang.String version)
version
- version of the server
public ServerTypeInfo addServer(java.lang.String name, java.lang.String version)
name
- name of the serverversion
- version of the server
public ServerTypeInfo addServer(java.lang.String name, java.lang.String version, java.lang.String[] platforms)
public ServerTypeInfo addServer(ServerTypeInfo server, java.lang.String[] platforms)
server
- Server type to clone.platforms
- Platforms supported by the server clone.
public void addServices(ServerTypeInfo server, java.lang.String[] services)
server
- the server the services belong toservices
- a list of services names to addpublic void addServices(ServerTypeInfo server, java.lang.String[] deployedServices, java.lang.String[] internalServices)
server
- deployedServices
- internalServices
- public void addServices(ServerTypeInfo fromServer, ServerTypeInfo toServer)
fromServer
- Server from which to clone services.toServer
- Server to which the clones services are tied.public ServiceTypeInfo addService(ServerTypeInfo server, java.lang.String name)
server
- server which the server belongs toname
- name of the service
public static java.lang.String composeServiceTypeName(java.lang.String serverName, java.lang.String serviceName)
public static java.lang.String composeServerTypeName(java.lang.String name, java.lang.String version)
public static java.lang.String composePlatformTypeName(java.lang.String name, java.lang.String platformName)
public ServerTypeInfo addServerAndServices(ServerTypeInfo server, java.lang.String[] platforms)
server
- Server to cloneplatforms
- Supported platforms of the server cloneaddServer(ServerTypeInfo server,String[] platforms)
,
addServices(ServerTypeInfo fromServer,ServerTypeInfo toServer)
public TypeInfo[] getTypes()
public boolean add(TypeInfo type)
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |