com.exalead.papi.helper.http

Class EndpointBuilder<PAPI extends PushAPI>

java.lang.Object

com.exalead.papi.helper.http.EndpointBuilder<PAPI>

Type Parameters:

PAPI - The type of the PushAPI

Direct Known Subclasses:

FakePushAPI.FakePushAPIEndpointBuilder

public abstract class EndpointBuilder<PAPI extends PushAPI>
extends java.lang.Object

A factory to spawn instances of the end-point PushAPI. The end-point PushAPI is the

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	connectorName
protected java.lang.String	connectorType
protected java.util.Map<java.lang.String,java.lang.String>	extraParameters
protected java.lang.String	host
protected java.lang.String	login
protected java.lang.String	password
protected java.lang.String	port
protected Protocol	protocol
protected java.lang.String	urlPrefix
protected PushAPIVersion	version

Constructor Summary

Constructors

Constructor and Description
EndpointBuilder()

Method Summary

Modifier and Type	Method and Description
abstract PAPI	build() Creates instances of end-point PushAPI.
EndpointBuilder<PAPI>	withConnectorName(java.lang.String connectorName)
EndpointBuilder<PAPI>	withConnectorType(java.lang.String connectorType)
EndpointBuilder<PAPI>	withExtraParameters(java.util.Map<java.lang.String,java.lang.String> extraParameters)
EndpointBuilder<PAPI>	withHost(java.lang.String host)
EndpointBuilder<PAPI>	withLogin(java.lang.String login)
EndpointBuilder<PAPI>	withPassword(java.lang.String password)
EndpointBuilder<PAPI>	withPort(java.lang.String port)
EndpointBuilder<PAPI>	withProtocol(Protocol protocol)
EndpointBuilder<PAPI>	withUrlPrefix(java.lang.String urlPrefix)
EndpointBuilder<PAPI>	withVersion(PushAPIVersion version)

Methods inherited from class java.lang.Object

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

Field Detail

version

protected PushAPIVersion version

protocol

protected Protocol protocol

host

protected java.lang.String host

port

protected java.lang.String port

urlPrefix

protected java.lang.String urlPrefix

connectorName

protected java.lang.String connectorName

connectorType

protected java.lang.String connectorType

login

protected java.lang.String login

password

protected java.lang.String password

extraParameters

protected java.util.Map<java.lang.String,java.lang.String> extraParameters

Constructor Detail

EndpointBuilder

public EndpointBuilder()

Method Detail

withVersion

public EndpointBuilder<PAPI> withVersion(PushAPIVersion version)

Parameters:

version - The veriosn of the protocol

Returns:

This builder's reference.

See Also:

PushAPIVersion

withProtocol

public EndpointBuilder<PAPI> withProtocol(Protocol protocol)

Parameters:

protocol - The network protocol

Returns:

This builder's reference.

See Also:

Protocol

withHost

public EndpointBuilder<PAPI> withHost(java.lang.String host)

Parameters:

host - The target host name

Returns:

This builder's reference.

withPort

public EndpointBuilder<PAPI> withPort(java.lang.String port)

Parameters:

port - The target host port

Returns:

This builder's reference.

withUrlPrefix

public EndpointBuilder<PAPI> withUrlPrefix(java.lang.String urlPrefix)

Parameters:

urlPrefix - The URL prefix, if any. Can be null

Returns:

This builder's reference.

withConnectorName

public EndpointBuilder<PAPI> withConnectorName(java.lang.String connectorName)

Parameters:

connectorName - The name of the source. Usually the connector name. Should not be null

Returns:

This builder's reference.

withConnectorType

public EndpointBuilder<PAPI> withConnectorType(java.lang.String connectorType)

Parameters:

connectorType - Connector type. Do not if it is ever used. Usually null.

Returns:

This builder's reference.

withLogin

public EndpointBuilder<PAPI> withLogin(java.lang.String login)

Parameters:

login - Login for authentication. Can be null

Returns:

This builder's reference.

withPassword

public EndpointBuilder<PAPI> withPassword(java.lang.String password)

Parameters:

password - Password for authentication. Can be null

Returns:

This builder's reference.

withExtraParameters

public EndpointBuilder<PAPI> withExtraParameters(java.util.Map<java.lang.String,java.lang.String> extraParameters)

Parameters:

extraParameters - Extra HTTP parameters. Can be null

Returns:

This builder's reference.

build

public abstract PAPI build()
                    throws PushAPIException

Creates instances of end-point PushAPI. As the name says, the end-point PushAPI is the API at the top of the PushAPI filters stack, being the one actually sending the data to any other server.

Returns:

A new instance of an end-point PushAPI.

Throws:

PushAPIException