Package co.ecg.alpaca.toolkit.model

Class BroadWorksServer

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksServer

All Implemented Interfaces:

Serializable, AutoCloseable

@Component
@Scope("prototype")
public class BroadWorksServer
extends Object
implements Serializable, AutoCloseable

The BroadWorksServer Class represents the connection to BroadWorks. It might be an External Web Server (XSP) or directly to an Application Server. A new instance of BroadWorksServer is needed for each User performing changes.

Author:

Matthew Keathley

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BroadWorksServer(LibraryProperties libraryProperties, OCSSwitchboard ocsSwitchboard, RequestBundler requestBundler, org.apache.jcs.JCS responseCache, HostIdCachingService hostIdCachingService)

Method Summary

Modifier and Type	Method	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.
void	connect(LibraryProperties.BroadWorksServerConfig configuration)	Delegate factory method for the creation of a BroadWorksServer.
boolean	equals(Object o)
String	fromTimeZone(TimeZone timeZone)
String	getNickName()
String	getRelease()
Connection	getTimesTenConnection()
Connection	getTimesTenConnection(boolean trySecondary)	Returns the Connection instance for this BroadWorksServer
int	hashCode()
boolean	timeZoneExists(String timeZoneString)
BroadWorksTimeZone	toTimeZone(String timeZone)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BroadWorksServer

@Autowired
public BroadWorksServer(LibraryProperties libraryProperties,
 OCSSwitchboard ocsSwitchboard,
 RequestBundler requestBundler,
 org.apache.jcs.JCS responseCache,
 HostIdCachingService hostIdCachingService)
                 throws co.ecg.licensing.LicenseException,
BroadWorksServerException

Throws:

co.ecg.licensing.LicenseException

BroadWorksServerException

Method Details

connect

public void connect(LibraryProperties.BroadWorksServerConfig configuration)
             throws BroadWorksServerException,
IOException,
co.ecg.licensing.LicenseException,
RequestException

Delegate factory method for the creation of a BroadWorksServer. Uses the current system time as the session id.

Parameters:

configuration - The LibraryProperties.BroadWorksServerConfig object as retrieved through an AlpacaProperties configuration.

Throws:

BroadWorksServerException

IOException

co.ecg.licensing.LicenseException

RequestException

getTimesTenConnection

public Connection getTimesTenConnection()
                                 throws TimesTenException

Throws:

TimesTenException

getTimesTenConnection

public Connection getTimesTenConnection(boolean trySecondary)
                                 throws TimesTenException

Returns the Connection instance for this BroadWorksServer

Throws:

TimesTenException - Thrown if unable to open the TimesTenConnection

clearCache

public boolean clearCache()

Clears the JCS Response Cache This causes all subsequent requests to get fresh results

Returns:

Returns true if the cache was successfully cleared

close

public void close()
           throws BroadWorksServerException

Closes the BroadWorksServer and frees the used socket.

Specified by:

close in interface AutoCloseable

Throws:

BroadWorksServerException - Thrown if an error occurs while closing the client.

getRelease

public String getRelease()

toTimeZone

public BroadWorksTimeZone toTimeZone(String timeZone)
                              throws BroadWorksServerException

Throws:

BroadWorksServerException

fromTimeZone

public String fromTimeZone(TimeZone timeZone)
                    throws BroadWorksServerException

Throws:

BroadWorksServerException

timeZoneExists

public boolean timeZoneExists(String timeZoneString)
                       throws BroadWorksServerException

Throws:

BroadWorksServerException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getNickName

public String getNickName()