|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Server
The interface of the server loaded by the ServerLoader
ServerLoader
Field Summary | |
---|---|
static String |
START_NOTIFICATION_TYPE
The JMX notification event type sent on end of server startup |
static String |
STOP_NOTIFICATION_TYPE
The JMX notification event type sent on begin of the server shutdown |
Method Summary | |
---|---|
String |
getBuildDate()
|
String |
getBuildID()
|
String |
getBuildJVM()
|
String |
getBuildNumber()
|
String |
getBuildOS()
|
ServerConfig |
getConfig()
Get the typed server configuration object which the server has been initalized to use. |
Map<String,Object> |
getMetaData()
Get the optional server configuration metadata |
Date |
getStartDate()
|
String |
getVersion()
|
String |
getVersionName()
|
String |
getVersionNumber()
|
void |
init(Properties props)
Initialize the Server instance by calling #init(Properties, Map=null) . |
void |
init(Properties props,
Map<String,Object> metaData)
Initialize the Server instance. |
boolean |
isInShutdown()
|
boolean |
isStarted()
Check if the server is started. |
void |
shutdown()
Shutdown the Server instance and run shutdown hooks. |
void |
start()
Start the Server instance. |
Field Detail |
---|
static final String START_NOTIFICATION_TYPE
static final String STOP_NOTIFICATION_TYPE
Method Detail |
---|
Date getStartDate()
String getVersion()
String getVersionName()
String getVersionNumber()
String getBuildNumber()
String getBuildJVM()
String getBuildOS()
String getBuildID()
String getBuildDate()
boolean isInShutdown()
void init(Properties props) throws IllegalStateException, Exception
#init(Properties, Map=null)
.
props
- The configuration properties for the server.
IllegalStateException
- Already initialized.
Exception
- Failed to initialize.void init(Properties props, Map<String,Object> metaData) throws IllegalStateException, Exception
props
- The configuration properties for the server.metadata
- configuration metadata for the server
IllegalStateException
- Already initialized.
Exception
- Failed to initialize.ServerConfig getConfig() throws IllegalStateException
IllegalStateException
- Not initialized.Map<String,Object> getMetaData()
void start() throws IllegalStateException, Exception
IllegalStateException
- Already started or not initialized.
Exception
- Failed to start.boolean isStarted()
void shutdown() throws IllegalStateException
If the exit on shutdown flag is true, then #exit()
is called, else only the shutdown hook is run.
IllegalStateException
- No started.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |