Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.queries
Class CfgApplicationQuery

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
      extended by com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery<CfgApplication>
          extended by com.genesyslab.platform.applicationblocks.com.queries.CfgApplicationQuery
All Implemented Interfaces:
ICfgFilterBasedQuery<CfgApplication>, ICfgQuery<CfgApplication>, ICfgQueryObjectClass<CfgApplication>

public class CfgApplicationQuery
extends CfgFilterBasedQuery<CfgApplication>

Class designed to construct queries to the Configuration Service for reading CfgApplication object(s).

See Also:
ConfService, CfgApplication

Constructor Summary
CfgApplicationQuery()
          Create query object with default filter value for configuration objects of CfgApplication type.
CfgApplicationQuery(IConfService service)
          Create query object with default filter value for configuration objects of CfgApplication type.
CfgApplicationQuery(int dbid)
          Create query object with filter initialized for the object DBID.
CfgApplicationQuery(java.lang.String name)
          Create query object with filter initialized for object name value.
 
Method Summary
 AsyncRequestResult<CfgApplication> beginExecute(Action<AsyncRequestResult<CfgApplication>> callback, java.lang.Object state)
          Begins the asynchronous execution of the current query.
 java.util.Collection<CfgApplication> execute()
          Executes the query and returns a list of CfgApplication objects.
 CfgApplication executeSingleResult()
          Executes a query the result of which is a single object.
 int getAccountDbid()
          A unique identifier of the object that may be used as an account for a daemon application (see type CfgObjectType).
 CfgObjectType getAccountType()
          Type of the object that may be used as an account for a daemon application (see CfgObjectType ).
 int getAppPrototypeDbid()
          A unique identifier of an application prototype.
 CfgAppType getAppType()
          Type of the application (see CfgAppType ).
 int getBackupServerDbid()
          A unique identifier of an application.
 int getDbid()
          A unique identifier of an application.
 int getHostDbid()
          A unique identifier of a host.
 CfgFlag getIsServer()
          An indicator of whether this application can be a server to some other applications.
 java.lang.String getName()
          Name of an application.
 int getNoClientDbid()
          If specified, Configuration Server will return information only about applications/servers which do not have any clients (there is no connection to this applications) configured.
 int getNoSwitchDbid()
          If specified, Configuration Server will return information only about T-Servers/ HAProxies that are not associated with any switches (see flexibleProperties above).
 int getPort()
          A server communication port.
 int getPrimaryServerDbid()
          A unique identifier of an application.
 int getSameHostAndPort()
          Configuration Server will return information only about applications currently registered on same host and port.
 int getServerDbid()
          A unique identifier of an application.
 CfgStartupType getStartupType()
          Startup type of the application (see CfgStartupType ).
 CfgObjectState getState()
          Current state of an application (see CfgObjectState ).
 int getSwitchDbid()
          A unique identifier of the switch.
 int getTenantDbid()
          A unique identifier of a tenant.
 java.lang.String getVersion()
          A version of the application.
 void setAccountDbid(int value)
          A unique identifier of the object that may be used as an account for a daemon application (see type CfgObjectType).
 void setAccountType(CfgObjectType value)
          Type of the object that may be used as an account for a daemon application (see CfgObjectType ).
 void setAppPrototypeDbid(int value)
          A unique identifier of an application prototype.
 void setAppType(CfgAppType value)
          Type of the application (see CfgAppType ).
 void setBackupServerDbid(int value)
          A unique identifier of an application.
 void setDbid(int value)
          A unique identifier of an application.
 void setHostDbid(int value)
          A unique identifier of a host.
 void setIsServer(CfgFlag value)
          An indicator of whether this application can be a server to some other applications.
 void setName(java.lang.String value)
          Name of an application.
 void setNoClientDbid(int value)
          If specified, Configuration Server will return information only about applications/servers which do not have any clients (there is no connection to this applications) configured.
 void setNoSwitchDbid(int value)
          If specified, Configuration Server will return information only about T-Servers/ HAProxies that are not associated with any switches (see flexibleProperties above).
 void setPort(int value)
          A server communication port.
 void setPrimaryServerDbid(int value)
          A unique identifier of an application.
 void setSameHostAndPort(int value)
          Configuration Server will return information only about applications currently registered on same host and port.
 void setServerDbid(int value)
          A unique identifier of an application.
 void setStartupType(CfgStartupType value)
          Startup type of the application (see CfgStartupType ).
 void setState(CfgObjectState value)
          Current state of an application (see CfgObjectState ).
 void setSwitchDbid(int value)
          A unique identifier of the switch.
 void setTenantDbid(int value)
          A unique identifier of a tenant.
 void setVersion(java.lang.String value)
          A version of the application.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery
equals, getCfgObjectClass, getCfgObjectType, getDoRequestFolderId, getDoRequestObjectPath, getExtraFilter, getFilter, getInt, getProperty, getQueryObjectClass, getString, hashCode, setDoRequestFolderId, setDoRequestObjectPath, setObjectClass, setProperty, toString
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgQuery
beginExecute, endExecute, execute, executeSingleResult
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgQuery
beginExecute, endExecute, execute, executeSingleResult
 

Constructor Detail

CfgApplicationQuery

public CfgApplicationQuery()
Create query object with default filter value for configuration objects of CfgApplication type. This query will not be executable.


CfgApplicationQuery

public CfgApplicationQuery(IConfService service)
Create query object with default filter value for configuration objects of CfgApplication type. If an instance of the configuration service is provided, the query will be executable.

Parameters:
service - The configuration service to use when executing this query

CfgApplicationQuery

public CfgApplicationQuery(int dbid)
Create query object with filter initialized for the object DBID.

Parameters:
dbid - value for filter on object dbid
See Also:
setDbid(int)

CfgApplicationQuery

public CfgApplicationQuery(java.lang.String name)
Create query object with filter initialized for object name value.

Parameters:
name - value for filter on object name
See Also:
setName(String)
Method Detail

executeSingleResult

public CfgApplication executeSingleResult()
                                   throws ConfigException
Executes a query the result of which is a single object. Exception will be thrown if multiple objects are returned by the configuration server.

Overrides:
executeSingleResult in class CfgQuery<CfgApplication>
Returns:
the CfgApplication object retrieved as a result of this operation
Throws:
ConfigException

execute

public java.util.Collection<CfgApplication> execute()
                                             throws ConfigException,
                                                    java.lang.InterruptedException
Executes the query and returns a list of CfgApplication objects.

Overrides:
execute in class CfgQuery<CfgApplication>
Returns:
A collection of CfgApplication objects
Throws:
ConfigException
java.lang.InterruptedException

beginExecute

public AsyncRequestResult<CfgApplication> beginExecute(Action<AsyncRequestResult<CfgApplication>> callback,
                                                       java.lang.Object state)
                                                throws ConfigException
Begins the asynchronous execution of the current query.

Parameters:
callback - The method to be called when query results are available
state - a user-defined object that qualifies or contains information about an asynchronous operation
Returns:
AsyncRequestResult describing the current operation
Throws:
ConfigException

setAppType

public final void setAppType(CfgAppType value)
Type of the application (see CfgAppType ). If specified, Configuration Server will return information only about the applications of this type.

Parameters:
value - filter value on field "app_type".

getAppType

public final CfgAppType getAppType()
Type of the application (see CfgAppType ). If specified, Configuration Server will return information only about the applications of this type.

Returns:
filter value or null (if applicable)
See Also:
setAppType(CfgAppType)

setTenantDbid

public final void setTenantDbid(int value)
A unique identifier of a tenant. If specified, Configuration Server will return information only about the applications that are associated with this tenant.

Parameters:
value - filter value on field "tenant_dbid".

getTenantDbid

public final int getTenantDbid()
A unique identifier of a tenant. If specified, Configuration Server will return information only about the applications that are associated with this tenant.

Returns:
filter value or null (if applicable)
See Also:
setTenantDbid(int)

setIsServer

public final void setIsServer(CfgFlag value)
An indicator of whether this application can be a server to some other applications. Depending on value specified, Configuration Server will return information only about the application(s) that are either servers or non-servers. See CfgFlag .

Parameters:
value - filter value on field "is_server".

getIsServer

public final CfgFlag getIsServer()
An indicator of whether this application can be a server to some other applications. Depending on value specified, Configuration Server will return information only about the application(s) that are either servers or non-servers. See CfgFlag .

Returns:
filter value or null (if applicable)
See Also:
setIsServer(CfgFlag)

setServerDbid

public final void setServerDbid(int value)
A unique identifier of an application. If specified, Configuration Server will return information only about the applications that are clients to this application.

Parameters:
value - filter value on field "server_dbid".

getServerDbid

public final int getServerDbid()
A unique identifier of an application. If specified, Configuration Server will return information only about the applications that are clients to this application.

Returns:
filter value or null (if applicable)
See Also:
setServerDbid(int)

setPrimaryServerDbid

public final void setPrimaryServerDbid(int value)
A unique identifier of an application. If specified, Configuration Server will return information only about the application that is backup to this application.

Parameters:
value - filter value on field "primary_server_dbid".

getPrimaryServerDbid

public final int getPrimaryServerDbid()
A unique identifier of an application. If specified, Configuration Server will return information only about the application that is backup to this application.

Returns:
filter value or null (if applicable)
See Also:
setPrimaryServerDbid(int)

setBackupServerDbid

public final void setBackupServerDbid(int value)
A unique identifier of an application. If specified, Configuration Server will return information only about the application that is primary to this application.

Parameters:
value - filter value on field "backup_server_dbid".

getBackupServerDbid

public final int getBackupServerDbid()
A unique identifier of an application. If specified, Configuration Server will return information only about the application that is primary to this application.

Returns:
filter value or null (if applicable)
See Also:
setBackupServerDbid(int)

setAppPrototypeDbid

public final void setAppPrototypeDbid(int value)
A unique identifier of an application prototype. If specified, Configuration Server will return information only about the applications that are based on this prototype.

Parameters:
value - filter value on field "app_prototype_dbid".

getAppPrototypeDbid

public final int getAppPrototypeDbid()
A unique identifier of an application prototype. If specified, Configuration Server will return information only about the applications that are based on this prototype.

Returns:
filter value or null (if applicable)
See Also:
setAppPrototypeDbid(int)

setAccountType

public final void setAccountType(CfgObjectType value)
Type of the object that may be used as an account for a daemon application (see CfgObjectType ). Makes sense only if used with the filter account_dbid (see below). If both account_type and account_dbid are specified, Configuration Server will return information only about the applications associated with this account. Such information will only be provided to the clients that have privileges to read access control list of this application.

Parameters:
value - filter value on field "account_type".

getAccountType

public final CfgObjectType getAccountType()
Type of the object that may be used as an account for a daemon application (see CfgObjectType ). Makes sense only if used with the filter account_dbid (see below). If both account_type and account_dbid are specified, Configuration Server will return information only about the applications associated with this account. Such information will only be provided to the clients that have privileges to read access control list of this application.

Returns:
filter value or null (if applicable)
See Also:
setAccountType(CfgObjectType)

setAccountDbid

public final void setAccountDbid(int value)
A unique identifier of the object that may be used as an account for a daemon application (see type CfgObjectType). Makes sense only if used with the filter account_type (see below). Makes sense only if used with the filter account_dbid (see below). If both account_type and account_dbid are specified, Configuration Server will return information only about the applications associated with this account. Such information will only be provided to the clients that have privileges to read access control list of this application.

Parameters:
value - filter value on field "account_dbid".

getAccountDbid

public final int getAccountDbid()
A unique identifier of the object that may be used as an account for a daemon application (see type CfgObjectType). Makes sense only if used with the filter account_type (see below). Makes sense only if used with the filter account_dbid (see below). If both account_type and account_dbid are specified, Configuration Server will return information only about the applications associated with this account. Such information will only be provided to the clients that have privileges to read access control list of this application.

Returns:
filter value or null (if applicable)
See Also:
setAccountDbid(int)

setHostDbid

public final void setHostDbid(int value)
A unique identifier of a host. If specified, Configuration Server will return information only about the applications currently assigned to this host.

Parameters:
value - filter value on field "host_dbid".

getHostDbid

public final int getHostDbid()
A unique identifier of a host. If specified, Configuration Server will return information only about the applications currently assigned to this host.

Returns:
filter value or null (if applicable)
See Also:
setHostDbid(int)

setPort

public final void setPort(int value)
A server communication port. If specified, Configuration Server will return information only about the applications currently registered at ports with this number. Consider using this filter with filter host_dbid (see above).

Parameters:
value - filter value on field "port".

getPort

public final int getPort()
A server communication port. If specified, Configuration Server will return information only about the applications currently registered at ports with this number. Consider using this filter with filter host_dbid (see above).

Returns:
filter value or null (if applicable)
See Also:
setPort(int)

setState

public final void setState(CfgObjectState value)
Current state of an application (see CfgObjectState ). If specified, Configuration Server will return information only about applications that are currently in this state.

Parameters:
value - filter value on field "state".

getState

public final CfgObjectState getState()
Current state of an application (see CfgObjectState ). If specified, Configuration Server will return information only about applications that are currently in this state.

Returns:
filter value or null (if applicable)
See Also:
setState(CfgObjectState)

setName

public final void setName(java.lang.String value)
Name of an application. Shall be specified as a character string. If specified, Configuration Server will return information only about the application with that name.

Parameters:
value - filter value on field "name".

getName

public final java.lang.String getName()
Name of an application. Shall be specified as a character string. If specified, Configuration Server will return information only about the application with that name.

Returns:
filter value or null (if applicable)
See Also:
setName(String)

setDbid

public final void setDbid(int value)
A unique identifier of an application. If specified, Configuration Server will return information only about this application.

Parameters:
value - filter value on field "dbid".

getDbid

public final int getDbid()
A unique identifier of an application. If specified, Configuration Server will return information only about this application.

Returns:
filter value or null (if applicable)
See Also:
setDbid(int)

setSameHostAndPort

public final void setSameHostAndPort(int value)
Configuration Server will return information only about applications currently registered on same host and port. Filter is intended to avoid the configuration collisions.

Parameters:
value - filter value on field "same_host_and_port".

getSameHostAndPort

public final int getSameHostAndPort()
Configuration Server will return information only about applications currently registered on same host and port. Filter is intended to avoid the configuration collisions.

Returns:
filter value or null (if applicable)
See Also:
setSameHostAndPort(int)

setSwitchDbid

public final void setSwitchDbid(int value)
A unique identifier of the switch. If specified, Configuration Server will return information only about T-Servers/HAProxies associated with this switch (see flexibleProperties above). The filter makes sense for application types T-Server and High Availability Proxy (CFGTServer; CFGHAProxy.)

Parameters:
value - filter value on field "switch_dbid".

getSwitchDbid

public final int getSwitchDbid()
A unique identifier of the switch. If specified, Configuration Server will return information only about T-Servers/HAProxies associated with this switch (see flexibleProperties above). The filter makes sense for application types T-Server and High Availability Proxy (CFGTServer; CFGHAProxy.)

Returns:
filter value or null (if applicable)
See Also:
setSwitchDbid(int)

setVersion

public final void setVersion(java.lang.String value)
A version of the application. Shall be specified as a character string. If specified, Configuration Server will return information only about applications with that version.

Parameters:
value - filter value on field "version".

getVersion

public final java.lang.String getVersion()
A version of the application. Shall be specified as a character string. If specified, Configuration Server will return information only about applications with that version.

Returns:
filter value or null (if applicable)
See Also:
setVersion(String)

setNoSwitchDbid

public final void setNoSwitchDbid(int value)
If specified, Configuration Server will return information only about T-Servers/ HAProxies that are not associated with any switches (see flexibleProperties above). The filter makes sense for application types T-Server and High Availability Proxy ( CFGTServer; CFGHAProxy.)

Parameters:
value - filter value on field "no_switch_dbid".

getNoSwitchDbid

public final int getNoSwitchDbid()
If specified, Configuration Server will return information only about T-Servers/ HAProxies that are not associated with any switches (see flexibleProperties above). The filter makes sense for application types T-Server and High Availability Proxy ( CFGTServer; CFGHAProxy.)

Returns:
filter value or null (if applicable)
See Also:
setNoSwitchDbid(int)

setNoClientDbid

public final void setNoClientDbid(int value)
If specified, Configuration Server will return information only about applications/servers which do not have any clients (there is no connection to this applications) configured.

Parameters:
value - filter value on field "no_client_dbid".

getNoClientDbid

public final int getNoClientDbid()
If specified, Configuration Server will return information only about applications/servers which do not have any clients (there is no connection to this applications) configured.

Returns:
filter value or null (if applicable)
See Also:
setNoClientDbid(int)

setStartupType

public final void setStartupType(CfgStartupType value)
Startup type of the application (see CfgStartupType ). If specified, Configuration Server will return information only about the applications of this startup type.

Parameters:
value - filter value on field "startup_type".

getStartupType

public final CfgStartupType getStartupType()
Startup type of the application (see CfgStartupType ). If specified, Configuration Server will return information only about the applications of this startup type.

Returns:
filter value or null (if applicable)
See Also:
setStartupType(CfgStartupType)

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.