public interface ServerInterface
Modifier and Type | Field and Description |
---|---|
static int |
SERVERSTATUS_DISPOSED
A Server that has been disposed.
|
static int |
SERVERSTATUS_RUNNING
A Server that is running.
|
static int |
SERVERSTATUS_STARTING
A Server that is starting.
|
static int |
SERVERSTATUS_STOPPED
A Server that is stopped.
|
static int |
SERVERSTATUS_STOPPING
A Server that is stopping.
|
static int |
SERVERSTATUS_SUSPENDED
A Server that is suspended.
|
static int |
SERVERSTATUS_UNKNOWN
A Server whose status is unknown.
|
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Disposes this Server.
|
String |
getName()
Gets the name of this Server.
|
int |
getPriority()
Gets the priority of this Server.
|
AttributeValue[] |
getProperties()
Gets the values for all dynamic properties for this Server.
|
AttributeValue |
getProperty(String name)
Gets the value of the specified dynamic property for this Server.
|
String |
getServerConfigurationName()
Gets the Server configuration name of this Server.
|
String |
getServerType()
Gets the type of this Server.
|
String |
getServiceName()
Gets the name of the default service for this Server.
|
int |
getStatus()
Gets the status of this Server.
|
boolean |
isAgent()
Gets whether this Server is an agent.
|
boolean |
isPropertyReadonly(String name)
Gets whether the specified dynamic property is readonly.
|
void |
restart()
Requests this Server to restart.
|
void |
resume()
Requests this Server to resume.
|
void |
setPriority(int priority)
Sets the priority of this Server.
|
void |
setProperty(AttributeValue av)
Sets the value of the specified dynamic property for this Server.
|
void |
start()
Requests this Server to start.
|
void |
stop()
Requests this Server to stop.
|
boolean |
supportsPriority()
Gets whether this Server supports set/get priority.
|
boolean |
supportsSuspendResume()
Gets whether this Server supports suspend/resume.
|
void |
suspend()
Requests this Server to suspend.
|
static final int SERVERSTATUS_UNKNOWN
static final int SERVERSTATUS_STOPPED
static final int SERVERSTATUS_RUNNING
static final int SERVERSTATUS_STOPPING
static final int SERVERSTATUS_STARTING
static final int SERVERSTATUS_SUSPENDED
static final int SERVERSTATUS_DISPOSED
String getName() throws IfsException
IfsException
- (IFS-45160) if the operation failsString getServerConfigurationName() throws IfsException
IfsException
- (IFS-45179) if the operation failsString getServiceName() throws IfsException
IfsException
- (IFS-45175) if the operation failsString getServerType() throws IfsException
Server type is used by CM SDK administration tools to aggregate data from servers of the same type in administration user interfaces.
IfsException
- (IFS-45177) if the operation failsboolean isAgent() throws IfsException
This method is called by CM SDK administration tools to group together servers that are agents in administration user interfaces.
IfsException
- (IFS-45178) if the operation failsint getStatus() throws IfsException
IfsException
- (IFS-45161) if the operation failsboolean supportsSuspendResume() throws IfsException
If false, then suspend
and resume
will throw an exception.
IfsException
- (IFS-45162) if the operation failsboolean supportsPriority() throws IfsException
If false, then setPriority
and getPriority
will throw an exception.
IfsException
- (IFS-45163) if the operation failsint getPriority() throws IfsException
The priority must be between Thread.MIN_PRIORITY
and Thread.MAX_PRIORITY
, inclusive.
IfsException
- (IFS-45170) if the operation failsvoid setPriority(int priority) throws IfsException
The priority must be between Thread.MIN_PRIORITY
and Thread.MAX_PRIORITY
, inclusive.
priority
- the priorityIfsException
- (IFS-45171) if the operation failsvoid start() throws IfsException
IfsException
- (IFS-45164) if the operation failsvoid stop() throws IfsException
IfsException
- (IFS-45165) if the operation failsvoid restart() throws IfsException
Restart is equivalent to a stop followed by a start.
IfsException
- (IFS-45166) if the operation failsvoid suspend() throws IfsException
IfsException
- (IFS-45167) if the operation failsvoid resume() throws IfsException
IfsException
- (IFS-45168) if the operation failsvoid dispose() throws IfsException
This deregisters the Server to unload it from the CM SDK node. The Server must already be stopped.
IfsException
- (IFS-45169) if the operation failsAttributeValue getProperty(String name) throws IfsException
name
- the property nameIfsException
- (IFS-45172) if the operation failsAttributeValue[] getProperties() throws IfsException
IfsException
- (IFS-45173) if the operation failsvoid setProperty(AttributeValue av) throws IfsException
av
- the property; the name of the AttributeValue
must be set and is the property nameIfsException
- (IFS-45174) if the operation failsboolean isPropertyReadonly(String name) throws IfsException
Readonly properties cannot be set using setProperty
.
name
- the property nameIfsException
- (IFS-45176) if the operation failsCopyright © 2023. All rights reserved.