public class BroadWorksServer extends Object implements Serializable
Constructor and Description |
---|
BroadWorksServer()
Serializable Constructor
|
Modifier and Type | Method and Description |
---|---|
boolean |
clearCache()
Clears the JCS Response Cache This causes all subsequent requests to get
fresh results
|
void |
close()
Closes the BroadWorksServer and frees the used socket.
|
boolean |
equals(Object o) |
static BroadWorksServer |
getBroadWorksServer(co.ecg.utilities.properties.BroadWorksServerConfig serverConfig)
Delegate factory method for the creation of a BroadWorksServer.
|
static BroadWorksServer |
getBroadWorksServer(String serverAddress,
String username,
String password,
int port,
co.ecg.utilities.properties.TimesTenConnectionConfig ttConfig,
String sessionId)
Factory method for the creation of a BroadWorksServer object that has
been successfully logged in.
|
co.ecg.utilities.properties.BroadWorksServerConfig |
getConfiguration() |
String |
getDefaultDomain() |
com.google.common.eventbus.EventBus |
getEventBus()
Returns the
EventBus instance for this BroadWorksServer |
String[] |
getHostID()
Retrieves the HostID array for the BroadWorksServer
|
long |
getLastRequestTime() |
OCSSwitchboard |
getOcsSwitchboard() |
RequestBundler |
getRequestBundler()
Returns the
RequestBundler instance for this BroadWorksServer |
org.apache.jcs.JCS |
getResponseCache() |
String |
getServerAddress() |
String |
getSessionId() |
String |
getSignedInUser() |
String |
getSignedInUserId() |
co.ecg.utilities.properties.TimesTenConnectionConfig |
getTimesTenConfig() |
Connection |
getTimesTenConnection()
Returns the
Connection instance for this BroadWorksServer |
int |
hashCode() |
void |
packetLimit()
This limits the number of packets per second that can be sent to the
BroadWorksServer.
|
void |
setLastRequestTime()
This stores the last time a request was sent to the OCI connection.
|
void |
setSignedInUser(String signedInUser) |
void |
setTimesTenConfig(co.ecg.utilities.properties.TimesTenConnectionConfig timestenConfig) |
public co.ecg.utilities.properties.BroadWorksServerConfig getConfiguration()
@GwtIncompatible public static BroadWorksServer getBroadWorksServer(co.ecg.utilities.properties.BroadWorksServerConfig serverConfig) throws BroadWorksServerException, IOException
serverConfig
- The BroadWorksServerConfig
object as retrieved through an AlpacaProperties configuration.BroadWorksServerException
IOException
@GwtIncompatible public static BroadWorksServer getBroadWorksServer(String serverAddress, String username, String password, int port, co.ecg.utilities.properties.TimesTenConnectionConfig ttConfig, String sessionId) throws BroadWorksServerException, IOException
serverAddress
- The IP address or hostname of the BroadWorks server. This
might be the External Web Server, or Application Server.username
- The username to asLogin with. The system-level administrative
username is "admin", but this can be another administrative
user, or an ordinary non-admin user.password
- The password to asLogin with.sessionId
- The session id for the BroadWorks connection.BroadWorksServerException
IOException
@GwtIncompatible public RequestBundler getRequestBundler()
RequestBundler
instance for this BroadWorksServer@GwtIncompatible public Connection getTimesTenConnection() throws BroadWorksServerException
Connection
instance for this BroadWorksServerBroadWorksServerException
- Thrown if unable to open the TimesTenConnection@GwtIncompatible public com.google.common.eventbus.EventBus getEventBus()
EventBus
instance for this BroadWorksServer@GwtIncompatible public boolean clearCache()
@GwtIncompatible public void close() throws BroadWorksServerException
BroadWorksServerException
- Thrown if an error occurs while closing the client.public long getLastRequestTime()
@GwtIncompatible public OCSSwitchboard getOcsSwitchboard()
@GwtIncompatible public org.apache.jcs.JCS getResponseCache()
public String getServerAddress()
public String getSessionId()
public String getSignedInUserId()
public String getDefaultDomain()
@GwtIncompatible public void packetLimit()
public void setLastRequestTime()
@GwtIncompatible public co.ecg.utilities.properties.TimesTenConnectionConfig getTimesTenConfig()
@GwtIncompatible public void setTimesTenConfig(co.ecg.utilities.properties.TimesTenConnectionConfig timestenConfig)
public String getSignedInUser()
public void setSignedInUser(String signedInUser)
public String[] getHostID()
Copyright © 2016 ECG. All rights reserved.