IsAliveCommand (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.Command
- - com.exalead.mercury.mami.search.v20.IsAliveCommand

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class IsAliveCommand
extends Command
implements com.exalead.util.Checkable, java.io.Serializable
```
Search API command

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.Command
  Command.Transformer<T>, Command.Visitor

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`asynchronousQueryDelayS`
`static int`	`DEFAULT_ASYNCHRONOUS_QUERY_DELAY_S`
`static boolean`	`DEFAULT_PERFORM_QUERY_SYNCHRONOUSLY`
`static java.lang.String`	`DEFAULT_QUERY_TO_PERFORM`
`static java.lang.String`	`DEFAULT_TARGET_QUERY_COMMAND`
`boolean`	`performQuerySynchronously`
`java.lang.String`	`queryToPerform`
`java.lang.String`	`targetQueryCommand`

Fields inherited from class com.exalead.mercury.mami.search.v20.Command
base, DEFAULT_BASE

Constructor Summary

Constructors
Constructor and Description

IsAliveCommand()

IsAliveCommand(IsAliveCommand o)
Copy constructor

Constructors
Constructor and Description
`IsAliveCommand()`
`IsAliveCommand(IsAliveCommand o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`accept(Command.Transformer<T> transformer, T[] t)`
`void`	`accept(Command.Visitor visitor)`
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this IsAliveCommand.
`static IsAliveCommand`	`fromString(java.lang.String s)` String representation of this IsAliveCommand.
`int`	`getAsynchronousQueryDelayS()` Elapsed between two queries if the query is performed asynchronously.
`java.lang.String`	`getQueryToPerform()` The isAlive can optionally perform a query to check that all components are ready. If you want this behavior, enter the search parameters to query for here. For example "q=test&logic=sl0".
`java.lang.String`	`getTargetQueryCommand()` Command path on which the query will be performed.
`boolean`	`isPerformQuerySynchronously()` Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned.
`IsAliveCommand`	`makeCopy()` Creates and returns a deep copy of this IsAliveCommand.
`static IsAliveCommand`	`readFrom(java.io.InputStream is)` Read this IsAliveCommand from an XML fragment.
`void`	`setAsynchronousQueryDelayS(int asynchronousQueryDelayS)` Elapsed between two queries if the query is performed asynchronously.
`void`	`setPerformQuerySynchronously(boolean performQuerySynchronously)` Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned.
`void`	`setQueryToPerform(java.lang.String queryToPerform)` The isAlive can optionally perform a query to check that all components are ready. If you want this behavior, enter the search parameters to query for here. For example "q=test&logic=sl0".
`void`	`setTargetQueryCommand(java.lang.String targetQueryCommand)` Command path on which the query will be performed.
`java.lang.String`	`toString()` String representation of this IsAliveCommand.
`IsAliveCommand`	`withAsynchronousQueryDelayS(int asynchronousQueryDelayS)`
`IsAliveCommand`	`withAsynchronousQueryDelayS(java.lang.Integer asynchronousQueryDelayS)`
`IsAliveCommand`	`withBase(java.lang.String base)`
`IsAliveCommand`	`withPerformQuerySynchronously(boolean performQuerySynchronously)`
`IsAliveCommand`	`withPerformQuerySynchronously(java.lang.Boolean performQuerySynchronously)`
`IsAliveCommand`	`withQueryToPerform(java.lang.String queryToPerform)`
`IsAliveCommand`	`withTargetQueryCommand(java.lang.String targetQueryCommand)`
`void`	`writeTo(java.io.OutputStream os)` Write this IsAliveCommand as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.Command
getBase, setBase

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - queryToPerform
```
public java.lang.String queryToPerform
```
  - DEFAULT_QUERY_TO_PERFORM
```
public static final java.lang.String DEFAULT_QUERY_TO_PERFORM
```
    See Also:
    
    Constant Field Values
  - targetQueryCommand
```
public java.lang.String targetQueryCommand
```
  - DEFAULT_TARGET_QUERY_COMMAND
```
public static final java.lang.String DEFAULT_TARGET_QUERY_COMMAND
```
    See Also:
    
    Constant Field Values
  - performQuerySynchronously
```
public boolean performQuerySynchronously
```
  - DEFAULT_PERFORM_QUERY_SYNCHRONOUSLY
```
public static final boolean DEFAULT_PERFORM_QUERY_SYNCHRONOUSLY
```
    See Also:
    
    Constant Field Values
  - asynchronousQueryDelayS
```
public int asynchronousQueryDelayS
```
  - DEFAULT_ASYNCHRONOUS_QUERY_DELAY_S
```
public static final int DEFAULT_ASYNCHRONOUS_QUERY_DELAY_S
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IsAliveCommand
```
public IsAliveCommand()
```
  - IsAliveCommand
```
public IsAliveCommand(IsAliveCommand o)
```
    Copy constructor
- Method Detail
  - withBase
```
public IsAliveCommand withBase(java.lang.String base)
```
    Overrides:
    
    withBase in class Command
  - setQueryToPerform
```
public void setQueryToPerform(java.lang.String queryToPerform)
```
    The isAlive can optionally perform a query to check that all components are ready.
    If you want this behavior, enter the search parameters to query for here.
    For example "q=test&logic=sl0". If this is null, the query won't be performed.
  - getQueryToPerform
```
public java.lang.String getQueryToPerform()
```
    The isAlive can optionally perform a query to check that all components are ready.
    If you want this behavior, enter the search parameters to query for here.
    For example "q=test&logic=sl0". If this is null, the query won't be performed.
  - withQueryToPerform
```
public IsAliveCommand withQueryToPerform(java.lang.String queryToPerform)
```
  - setTargetQueryCommand
```
public void setTargetQueryCommand(java.lang.String targetQueryCommand)
```
    Command path on which the query will be performed.
  - getTargetQueryCommand
```
public java.lang.String getTargetQueryCommand()
```
    Command path on which the query will be performed.
  - withTargetQueryCommand
```
public IsAliveCommand withTargetQueryCommand(java.lang.String targetQueryCommand)
```
  - setPerformQuerySynchronously
```
public void setPerformQuerySynchronously(boolean performQuerySynchronously)
```
    Should the query be performed synchronously on isAlive call
    or should it run in a background thread, and cached result be
    returned.
  - isPerformQuerySynchronously
```
public boolean isPerformQuerySynchronously()
```
    Should the query be performed synchronously on isAlive call
    or should it run in a background thread, and cached result be
    returned.
  - withPerformQuerySynchronously
```
public IsAliveCommand withPerformQuerySynchronously(boolean performQuerySynchronously)
```
  - withPerformQuerySynchronously
```
public IsAliveCommand withPerformQuerySynchronously(java.lang.Boolean performQuerySynchronously)
```
  - setAsynchronousQueryDelayS
```
public void setAsynchronousQueryDelayS(int asynchronousQueryDelayS)
```
    Elapsed between two queries if the query is performed asynchronously.
  - getAsynchronousQueryDelayS
```
public int getAsynchronousQueryDelayS()
```
    Elapsed between two queries if the query is performed asynchronously.
  - withAsynchronousQueryDelayS
```
public IsAliveCommand withAsynchronousQueryDelayS(int asynchronousQueryDelayS)
```
  - withAsynchronousQueryDelayS
```
public IsAliveCommand withAsynchronousQueryDelayS(java.lang.Integer asynchronousQueryDelayS)
```
  - makeCopy
```
public IsAliveCommand makeCopy()
```
    Creates and returns a deep copy of this IsAliveCommand.
    
    Overrides:
    
    makeCopy in class Command
  - readFrom
```
public static IsAliveCommand readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException
```
    Read this IsAliveCommand from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this IsAliveCommand as an XML fragment
    
    Overrides:
    
    writeTo in class Command
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static IsAliveCommand fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException
```
    String representation of this IsAliveCommand.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this IsAliveCommand.
    
    Overrides:
    
    toString in class Command
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this IsAliveCommand.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class Command
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public void accept(Command.Visitor visitor)
            throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class Command
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(Command.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class Command
    
    Throws:
    
    com.exalead.util.TypedException

Class IsAliveCommand

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.Command

Field Summary

Fields inherited from class com.exalead.mercury.mami.search.v20.Command

Constructor Summary

Method Summary

Methods inherited from class com.exalead.mercury.mami.search.v20.Command

Methods inherited from class java.lang.Object

Field Detail

queryToPerform

DEFAULT_QUERY_TO_PERFORM

targetQueryCommand

DEFAULT_TARGET_QUERY_COMMAND

performQuerySynchronously

DEFAULT_PERFORM_QUERY_SYNCHRONOUSLY

asynchronousQueryDelayS

DEFAULT_ASYNCHRONOUS_QUERY_DELAY_S

Constructor Detail

IsAliveCommand

IsAliveCommand

Method Detail

withBase

setQueryToPerform

getQueryToPerform

withQueryToPerform

setTargetQueryCommand

getTargetQueryCommand

withTargetQueryCommand

setPerformQuerySynchronously

isPerformQuerySynchronously

withPerformQuerySynchronously

withPerformQuerySynchronously

setAsynchronousQueryDelayS

getAsynchronousQueryDelayS

withAsynchronousQueryDelayS

withAsynchronousQueryDelayS

makeCopy

readFrom

writeTo

fromString

toString

check

accept

accept