com.crystaldecisions.sdk.plugin.admin.eventserveradmin
Interface IEventServerAdmin

Deprecated. As of version 12.0.

public interface IEventServerAdmin

The IEventServerAdmin interface contains properties and methods for monitoring and managing the Event Server. You can also adjust the polling time and return the collection of files used to trigger the events.

Method Summary

void	commit() Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.
int	getEvents() Deprecated. As of version 12.0.
int	getFilePollTime() Deprecated. As of version 12.0.
java.lang.String	getHostname() Deprecated. As of version 12.0.
IEventServerAdminFile[]	getListFileMonitored() Deprecated. As of version 12.0.
void	setFilePollTime(int n) Deprecated. As of version 12.0.

Method Detail

getFilePollTime

int getFilePollTime()
                    throws SDKException

Deprecated. As of version 12.0.

Returns how often the Event Server polls for a file that will trigger an event. The value returned is in seconds.

Returns:

An int specifying how often the Event Server polls for a file that will trigger an event.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFilePollTime

void setFilePollTime(int n)
                     throws SDKException

Deprecated. As of version 12.0.

Sets how often the Event Server polls for a file that will trigger an event. The default is two seconds. However, it is important to note that, the lower the value, the more resources the server requires.

Parameters:

n - An int specifying how often the Event Server polls for a file that will trigger an event.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getHostname

java.lang.String getHostname()
                             throws SDKException

Deprecated. As of version 12.0.

Returns the host name of the Event Server.

Returns:

A String containing the host name of the Event Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getListFileMonitored

IEventServerAdminFile[] getListFileMonitored()
                                             throws SDKException

Deprecated. As of version 12.0.

Returns a collection of files monitored by the Event Server.

Returns:

An array of IEventServerAdminFile objects that represent the files monitored by the Event Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getEvents

int getEvents()
              throws SDKException

Deprecated. As of version 12.0.

Returns the total number of events monitored by the Event Server.

Returns:

An int specifying the total number of events monitored by the Event server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.

Commits to the CMS any changes that are made to the Event Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.