flux
Interface EngineInfo

All Superinterfaces:

java.io.Serializable

public interface EngineInfo
extends java.io.Serializable

Contains information about an engine in a cluster.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

Engine	createEngineReference() Returns a fresh remote engine reference.
java.lang.String	getHost() Returns the host of the represented engine.
java.lang.String	getName() Returns the name of the represented engine.
int	getPort() Returns the port where the engine is running.
boolean	isLocal() Indicates whether this engine is a local or remote engine.
boolean	isReachable() Indicates whether this engine is accessible.
boolean	isSecured() Indicates whether this engine has security enabled.
boolean	isSsl() Indicates whether this engine is secured with SSL.

Method Detail

createEngineReference

Engine createEngineReference()
                             throws EngineException

Returns a fresh remote engine reference. The engine reference is created when this method is called. The engine reference will become stale if the engine is restarted after calling this method.

Returns:

A remote engine reference. Null is returned if the engine is not an remote engine

Throws:

EngineException - If a system error occurs, the engine could not be reached, or is a secured engine and authentication failed.

EngineCommunicationException - If a networking error occurs.

getHost

java.lang.String getHost()

Returns the host of the represented engine.

Returns:

The host of the represented engine.

getName

java.lang.String getName()

Returns the name of the represented engine.

Returns:

The name of the represented engine.

getPort

int getPort()

Returns the port where the engine is running.

Returns:

The port where the engine is running.

isLocal

boolean isLocal()

Indicates whether this engine is a local or remote engine.

Returns:

Whether this engine is a local or remote engine.

isReachable

boolean isReachable()
                    throws EngineException

Indicates whether this engine is accessible.

Returns:

Whether this engine is accessible. A false value is returned if the represented engine is not an remote engine.

Throws:

EngineCommunicationException - If a networking error occurs.

EngineException

isSecured

boolean isSecured()
                  throws EngineException

Indicates whether this engine has security enabled.

Returns:

Whether this engine has security enabled.

Throws:

EngineCommunicationException - If a networking error occurs.

EngineException

isSsl

boolean isSsl()

Indicates whether this engine is secured with SSL.

Returns:

Whether this engine is secured with SSL.