|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgQuery<TT>
com.genesyslab.platform.applicationblocks.com.CfgFilterBasedQuery<CfgApplication>
com.genesyslab.platform.applicationblocks.com.queries.CfgApplicationQuery
public class CfgApplicationQuery
Class designed to construct queries to the Configuration Service for reading CfgApplication object(s).
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 |
---|
public CfgApplicationQuery()
public CfgApplicationQuery(IConfService service)
service
- The configuration service to use when executing this querypublic CfgApplicationQuery(int dbid)
dbid
- value for filter on object dbidsetDbid(int)
public CfgApplicationQuery(java.lang.String name)
name
- value for filter on object namesetName(String)
Method Detail |
---|
public CfgApplication executeSingleResult() throws ConfigException
executeSingleResult
in class CfgQuery<CfgApplication>
ConfigException
public java.util.Collection<CfgApplication> execute() throws ConfigException, java.lang.InterruptedException
execute
in class CfgQuery<CfgApplication>
ConfigException
java.lang.InterruptedException
public AsyncRequestResult<CfgApplication> beginExecute(Action<AsyncRequestResult<CfgApplication>> callback, java.lang.Object state) throws ConfigException
callback
- The method to be called when query results are availablestate
- a user-defined object that qualifies or contains information about an asynchronous operation
ConfigException
public final void setAppType(CfgAppType value)
CfgAppType
). If specified, Configuration Server will
return information only about the applications of this type.
value
- filter value on field "app_type".public final CfgAppType getAppType()
CfgAppType
). If specified, Configuration Server will
return information only about the applications of this type.
setAppType(CfgAppType)
public final void setTenantDbid(int value)
value
- filter value on field "tenant_dbid".public final int getTenantDbid()
setTenantDbid(int)
public final void setIsServer(CfgFlag value)
CfgFlag
.
value
- filter value on field "is_server".public final CfgFlag getIsServer()
CfgFlag
.
setIsServer(CfgFlag)
public final void setServerDbid(int value)
value
- filter value on field "server_dbid".public final int getServerDbid()
setServerDbid(int)
public final void setPrimaryServerDbid(int value)
value
- filter value on field "primary_server_dbid".public final int getPrimaryServerDbid()
setPrimaryServerDbid(int)
public final void setBackupServerDbid(int value)
value
- filter value on field "backup_server_dbid".public final int getBackupServerDbid()
setBackupServerDbid(int)
public final void setAppPrototypeDbid(int value)
value
- filter value on field "app_prototype_dbid".public final int getAppPrototypeDbid()
setAppPrototypeDbid(int)
public final void setAccountType(CfgObjectType value)
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.
value
- filter value on field "account_type".public final CfgObjectType getAccountType()
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.
setAccountType(CfgObjectType)
public final void setAccountDbid(int value)
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.
value
- filter value on field "account_dbid".public final int getAccountDbid()
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.
setAccountDbid(int)
public final void setHostDbid(int value)
value
- filter value on field "host_dbid".public final int getHostDbid()
setHostDbid(int)
public final void setPort(int value)
host_dbid
(see above).
value
- filter value on field "port".public final int getPort()
host_dbid
(see above).
setPort(int)
public final void setState(CfgObjectState value)
CfgObjectState
). If specified, Configuration Server
will return information only about applications that are currently
in this state.
value
- filter value on field "state".public final CfgObjectState getState()
CfgObjectState
). If specified, Configuration Server
will return information only about applications that are currently
in this state.
setState(CfgObjectState)
public final void setName(java.lang.String value)
value
- filter value on field "name".public final java.lang.String getName()
setName(String)
public final void setDbid(int value)
value
- filter value on field "dbid".public final int getDbid()
setDbid(int)
public final void setSameHostAndPort(int value)
value
- filter value on field "same_host_and_port".public final int getSameHostAndPort()
setSameHostAndPort(int)
public final void setSwitchDbid(int value)
flexibleProperties
above). The filter makes
sense for application types T-Server and High Availability Proxy
(CFGTServer; CFGHAProxy.
)
value
- filter value on field "switch_dbid".public final int getSwitchDbid()
flexibleProperties
above). The filter makes
sense for application types T-Server and High Availability Proxy
(CFGTServer; CFGHAProxy.
)
setSwitchDbid(int)
public final void setVersion(java.lang.String value)
value
- filter value on field "version".public final java.lang.String getVersion()
setVersion(String)
public final void setNoSwitchDbid(int value)
flexibleProperties
above). The filter makes
sense for application types T-Server and High Availability Proxy
( CFGTServer; CFGHAProxy.
)
value
- filter value on field "no_switch_dbid".public final int getNoSwitchDbid()
flexibleProperties
above). The filter makes
sense for application types T-Server and High Availability Proxy
( CFGTServer; CFGHAProxy.
)
setNoSwitchDbid(int)
public final void setNoClientDbid(int value)
value
- filter value on field "no_client_dbid".public final int getNoClientDbid()
setNoClientDbid(int)
public final void setStartupType(CfgStartupType value)
CfgStartupType
). If specified, Configuration Server will
return information only about the applications of this startup type.
value
- filter value on field "startup_type".public final CfgStartupType getStartupType()
CfgStartupType
). If specified, Configuration Server will
return information only about the applications of this startup type.
setStartupType(CfgStartupType)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |