com.solidfire.client

Class AbstractFactory<T extends ServiceBase>

Object

AbstractFactory<T>

Type Parameters:

T - extends ServiceBase

Direct Known Subclasses:

ElementFactory

public abstract class AbstractFactory<T extends ServiceBase>
extends Object

The Abstract Factory defines the version checking logic for an implementation factory that instantiates a ServiceBase.

See Also:

checkVersion(String, Optional, String, String, Optional, boolean)

Constructor Summary

Constructors

Constructor and Description
AbstractFactory()

Method Summary

Methods

Modifier and Type	Method and Description
protected RequestDispatcher	buildRequestDispatcher(String target, Optional<Integer> port, String username, String password, Optional<String> apiVersion, boolean verifySSL)
protected T	checkVersion(String target, Optional<Integer> port, String username, String password, Optional<String> version, boolean verifySSL) Checks the version of an endpoint against the target endpoint.
protected abstract double	getMaxApiVersion() Getter for property 'maxApiVersion'.
protected abstract double	getMinApiVersion() Getter for property 'minApiVersion'.
protected static void	testTargetFormat(String target, boolean verifySSL) Checks if the provided target is in the form of an IP address or a hostname.
protected static URL	toEndpoint(String target, Optional<Integer> port, double apiVersion) Creates a URL representation of a SolidFire API endpoint, depending on the optional value of port, in the form: https://{target}:{port}/json-rpc/{apiVersion} or https://{target}/json-rpc/{apiVersion}
protected abstract T	toServiceBase(RequestDispatcher requestDispatcher) Initializes the ServiceBase with a given RequestDispatcher.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFactory

public AbstractFactory()

Method Detail

getMinApiVersion

protected abstract double getMinApiVersion()

Getter for property 'minApiVersion'.

Returns:

Value for property 'minApiVersion'.

getMaxApiVersion

protected abstract double getMaxApiVersion()

Getter for property 'maxApiVersion'.

Returns:

Value for property 'maxApiVersion'.

toServiceBase

protected abstract T toServiceBase(RequestDispatcher requestDispatcher)

Initializes the ServiceBase with a given RequestDispatcher.

Parameters:

requestDispatcher - the instantiated RequestBuilder

Returns:

the initialized ServiceBase

buildRequestDispatcher

protected RequestDispatcher buildRequestDispatcher(String target,
                                       Optional<Integer> port,
                                       String username,
                                       String password,
                                       Optional<String> apiVersion,
                                       boolean verifySSL)

Parameters:

target - the management virtual IP (or hostname)

port - the port to use

username - admin username

password - admin password

apiVersion - the version of the API services

verifySSL - if set to true, the target will be checked against the list of valid SSL hosts, including verification of the validity of the Cert recorded for a given target, otherwise these validity checks are ignored, which is useful when the target is an IP address.

Returns:

an initialized RequestBuilder

testTargetFormat

protected static void testTargetFormat(String target,
                    boolean verifySSL)

Checks if the provided target is in the form of an IP address or a hostname. Depending on the value of verifySSL, this method will throw an ApiException because IP addresses will not have a proper SSL certificate.

Parameters:

target - the management virtual IP (or hostname)

verifySSL - if set to true, the target will be checked against the list of valid SSL hosts, including verification of the validity of the Cert recorded for a given target, otherwise these validity checks are ignored, which is useful when the target is an IP address.

Throws:

ApiException - when target is in the form of an IP address and verifySSL is true.

toEndpoint

protected static URL toEndpoint(String target,
             Optional<Integer> port,
             double apiVersion)

Creates a URL representation of a SolidFire API endpoint, depending on the optional value of port, in the form: https://{target}:{port}/json-rpc/{apiVersion} or https://{target}/json-rpc/{apiVersion}

Parameters:

target - the management virtual IP (or hostname)

port - (optional) the port to use

apiVersion - the version of the API services

Returns:

URL representing the SolidFire API endpoint

checkVersion

protected T checkVersion(String target,
             Optional<Integer> port,
             String username,
             String password,
             Optional<String> version,
             boolean verifySSL)

Checks the version of an endpoint against the target endpoint. If the version is malformed, lower then the minimally supported version, or the version is not supported on the cluster, an exception is thrown. If the version provided is higher the the maximum supported version for the SDK, a warning is generated, but the ServiceBase implementation is returned. If a version is not supplied, either the highest supported version of the Cluster or the maximum supported version of the Cluster, which ever is lower, is used.

Parameters:

target - the management virtual IP (or hostname)

port - (optional) the port to use

username - admin username

password - admin password

version - (optional) the requested supported version of the SolidFire Cluster

verifySSL - if set to true, the target will be checked against the list of valid SSL hosts, including verification of the validity of the Cert recorded for a given target, otherwise these validity checks are ignored, which is useful when the target is an IP address.

Returns:

T the implementation of ServiceBase initialized with the properly constructed RequestDispatcher