Package com.helger.photon.api

Class APIDescriptor

java.lang.Object

com.helger.photon.api.APIDescriptor

All Implemented Interfaces:

IAPIDescriptor

@NotThreadSafe
public class APIDescriptor
extends Object
implements IAPIDescriptor

Default implementation of IAPIDescriptor.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
APIDescriptor(APIPath aPath, IAPIExecutor aExecutor)	Constructor
APIDescriptor(APIPath aPath, Class<? extends IAPIExecutor> aExecutorClass)	Constructor
APIDescriptor(APIPath aPath, Supplier<? extends IAPIExecutor> aExecutorFactory)	Constructor

Method Summary

Modifier and Type	Method	Description
APIDescriptor	addRequiredHeader(String sHeaderName)	Add a required HTTP header.
APIDescriptor	addRequiredHeaders(String... aHeaderNames)	Add one or more required HTTP headers.
APIDescriptor	addRequiredParam(String sParamName)	Add a required request parameter.
APIDescriptor	addRequiredParams(String... aParamNames)	Add one or more required request parameters.
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	allowedMimeTypes()
APIPath	getAPIPath()
IAPIExceptionMapper	getExceptionMapper()
IAPIExecutionFilter	getExecutionFilter()
Supplier<? extends IAPIExecutor>	getExecutorFactory()
PathDescriptor	getPathDescriptor()
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	requiredHeaders()
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	requiredParams()
APIDescriptor	setExceptionMapper(IAPIExceptionMapper aExceptionMapper)
APIDescriptor	setExecutionFilter(IAPIExecutionFilter aExecutionFilter)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.api.IAPIDescriptor

getHttpMethod, hasExceptionMapper, hasExecutionFilter

Constructor Detail

APIDescriptor

public APIDescriptor(@Nonnull
                     APIPath aPath,
                     @Nonnull
                     IAPIExecutor aExecutor)

Constructor

Parameters:

aPath - API Path to be used. May not be null.

aExecutor - The executor to be invoked for that API. May not be null.

APIDescriptor

public APIDescriptor(@Nonnull
                     APIPath aPath,
                     @Nonnull
                     Class<? extends IAPIExecutor> aExecutorClass)

Constructor

Parameters:

aPath - API Path to be used. May not be null.

aExecutorClass - The executor class to be instantiated for every API invocation. May not be null.

APIDescriptor

public APIDescriptor(@Nonnull
                     APIPath aPath,
                     @Nonnull
                     Supplier<? extends IAPIExecutor> aExecutorFactory)

Constructor

Parameters:

aPath - API Path to be used. May not be null.

aExecutorFactory - The factory to be used to create executor instances for every API invocation. May not be null.

Method Detail

getAPIPath

@Nonnull
public final APIPath getAPIPath()

Specified by:

getAPIPath in interface IAPIDescriptor

Returns:

The API path used. Never null.

getPathDescriptor

@Nonnull
public final PathDescriptor getPathDescriptor()

Specified by:

getPathDescriptor in interface IAPIDescriptor

Returns:

The path descriptor required to call this API.

getExecutorFactory

@Nonnull
public final Supplier<? extends IAPIExecutor> getExecutorFactory()

Specified by:

getExecutorFactory in interface IAPIDescriptor

Returns:

The non-null factory used to create the main invoker.

addRequiredHeader

@Nonnull
public final APIDescriptor addRequiredHeader(@Nullable
                                             String sHeaderName)

Add a required HTTP header. If this HTTP header is not present, invocation will not be possible.

Parameters:

sHeaderName - The name of the required HTTP header. May be null or empty in which case the header is ignored.

Returns:

this for chaining

See Also:

addRequiredHeaders(String...)

addRequiredHeaders

@Nonnull
public final APIDescriptor addRequiredHeaders(@Nullable
                                              String... aHeaderNames)

Add one or more required HTTP headers. If one of these HTTP headers are not present, invocation will not be possible.

Parameters:

aHeaderNames - The names of the required HTTP headers. May be null or empty.

Returns:

this for chaining

See Also:

addRequiredHeader(String)

requiredHeaders

@Nonnull
@ReturnsMutableObject
public final com.helger.commons.collection.impl.ICommonsOrderedSet<String> requiredHeaders()

Specified by:

requiredHeaders in interface IAPIDescriptor

Returns:

The names of all required HTTP headers. Never null but maybe empty.

addRequiredParam

@Nonnull
public final APIDescriptor addRequiredParam(@Nullable
                                            String sParamName)

Add a required request parameter. If this request parameter is not present, invocation will not be possible.

Parameters:

sParamName - The name of the required request parameter. May be null or empty in which case the parameter is ignored.

Returns:

this for chaining

See Also:

addRequiredParams(String...)

addRequiredParams

@Nonnull
public final APIDescriptor addRequiredParams(@Nullable
                                             String... aParamNames)

Add one or more required request parameters. If one of these request parameters are not present, invocation will not be possible.

Parameters:

aParamNames - The names of the required HTTP parameters. May be null or empty.

Returns:

this for chaining

See Also:

addRequiredParam(String)

requiredParams

@Nonnull
@ReturnsMutableObject
public final com.helger.commons.collection.impl.ICommonsOrderedSet<String> requiredParams()

Specified by:

requiredParams in interface IAPIDescriptor

Returns:

The names of all required request parameters. Never null but maybe empty.

allowedMimeTypes

@Nonnull
@ReturnsMutableObject
public final com.helger.commons.collection.impl.ICommonsOrderedSet<String> allowedMimeTypes()

Specified by:

allowedMimeTypes in interface IAPIDescriptor

Returns:

The names of all allowed MIME types for the data. Never null but maybe empty. Only MIME types without parameters (as in ";x=y") should be added here. Also unified casing should be considered.

getExecutionFilter

@Nullable
public final IAPIExecutionFilter getExecutionFilter()

Specified by:

getExecutionFilter in interface IAPIDescriptor

Returns:

The current execution filter. May be null.

setExecutionFilter

@Nonnull
public final APIDescriptor setExecutionFilter(@Nullable
                                              IAPIExecutionFilter aExecutionFilter)

getExceptionMapper

@Nullable
public final IAPIExceptionMapper getExceptionMapper()

Specified by:

getExceptionMapper in interface IAPIDescriptor

Returns:

The exception mapper for this descriptor. May be null.

setExceptionMapper

@Nonnull
public final APIDescriptor setExceptionMapper(@Nullable
                                              IAPIExceptionMapper aExceptionMapper)

toString

public String toString()

Overrides:

toString in class Object