A B C D E G H I L M N O P R S T V
All Classes All Packages

A

AbstractAPIExceptionMapper - Class in com.helger.photon.api

Abstract implementation of IAPIExceptionMapper with some helper methods.

AbstractAPIExceptionMapper() - Constructor for class com.helger.photon.api.AbstractAPIExceptionMapper

addDescriptor(APIDescriptor) - Method in class com.helger.photon.api.APIDescriptorList

addRequiredHeader(String) - Method in class com.helger.photon.api.APIDescriptor

Add a required HTTP header.

addRequiredHeaders(String...) - Method in class com.helger.photon.api.APIDescriptor

Add one or more required HTTP headers.

addRequiredParam(String) - Method in class com.helger.photon.api.APIDescriptor

Add a required request parameter.

addRequiredParams(String...) - Method in class com.helger.photon.api.APIDescriptor

Add one or more required request parameters.

afterExecutionCallbacks() - Static method in class com.helger.photon.api.APISettings

allowedMimeTypes() - Method in class com.helger.photon.api.APIDescriptor

allowedMimeTypes() - Method in interface com.helger.photon.api.IAPIDescriptor

and(IAPIExecutionFilter) - Method in interface com.helger.photon.api.IAPIExecutionFilter

and(IAPIExecutionFilter, IAPIExecutionFilter) - Static method in interface com.helger.photon.api.IAPIExecutionFilter

APIDescriptor - Class in com.helger.photon.api

Default implementation of IAPIDescriptor.

APIDescriptor(APIPath, IAPIExecutor) - Constructor for class com.helger.photon.api.APIDescriptor

Constructor

APIDescriptor(APIPath, Class<? extends IAPIExecutor>) - Constructor for class com.helger.photon.api.APIDescriptor

Constructor

APIDescriptor(APIPath, Supplier<? extends IAPIExecutor>) - Constructor for class com.helger.photon.api.APIDescriptor

Constructor

APIDescriptorList - Class in com.helger.photon.api

This class manages a list of APIDescriptor objects.

APIDescriptorList() - Constructor for class com.helger.photon.api.APIDescriptorList

APIInvoker - Class in com.helger.photon.api

Default implementation of IAPIInvoker.

APIInvoker() - Constructor for class com.helger.photon.api.APIInvoker

APIPath - Class in com.helger.photon.api

This class contains a combination of path and HTTP method.

APIPath(EHttpMethod, String) - Constructor for class com.helger.photon.api.APIPath

Constructor

APIRegistry - Class in com.helger.photon.api

Default implementation if IAPIRegistry.

APIRegistry() - Constructor for class com.helger.photon.api.APIRegistry

APISettings - Class in com.helger.photon.api

A central helper class that centrally configures all API callbacks.

APIXServletHandler - Class in com.helger.photon.api.servlet

Abstract API servlet.

APIXServletHandler() - Constructor for class com.helger.photon.api.servlet.APIXServletHandler

APIXServletHandler(Supplier<? extends IAPIRegistry>, Supplier<? extends IAPIInvoker>) - Constructor for class com.helger.photon.api.servlet.APIXServletHandler

apply(APIPath, ICommonsList<InvokableAPIDescriptor>) - Method in interface com.helger.photon.api.IAPIPathAmbiguityResolver

apply(APIPath, ICommonsList<InvokableAPIDescriptor>) - Method in class com.helger.photon.api.LoggingAPIPathAmbiguityResolver

applyExceptionOnResponse(InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, UnifiedResponse, Throwable) - Method in interface com.helger.photon.api.IAPIExceptionMapper

B

beforeExecutionCallbacks() - Static method in class com.helger.photon.api.APISettings

C

canExecute(IRequestWebScopeWithoutResponse) - Method in interface com.helger.photon.api.IAPIExecutionFilter

Check if the passed request can be executed or not.

canExecute(IRequestWebScopeWithoutResponse, MutableInt) - Method in class com.helger.photon.api.InvokableAPIDescriptor

Check if all pre-requisites are handled correctly.

com.helger.photon.api - package com.helger.photon.api

com.helger.photon.api.callback - package com.helger.photon.api.callback

com.helger.photon.api.pathdescriptor - package com.helger.photon.api.pathdescriptor

com.helger.photon.api.servlet - package com.helger.photon.api.servlet

CONSTRAINT_SEPARATOR - Static variable in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

containsVariables() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

create(String) - Static method in class com.helger.photon.api.pathdescriptor.PathDescriptor

create(String) - Static method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

createForFilter(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.api.APIPath

createForServlet(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.api.APIPath

createOrNull(String) - Static method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

Factory method.

createSuccess(ICommonsOrderedMap<String, String>) - Static method in class com.helger.photon.api.pathdescriptor.PathMatchingResult

createUnifiedResponse(EHttpVersion, EHttpMethod, HttpServletRequest, IRequestWebScope) - Method in class com.helger.photon.api.servlet.APIXServletHandler

D

DEFAULT_LONG_RUNNING_EXECUTION_LIMIT_MS - Static variable in class com.helger.photon.api.APISettings

Default milliseconds until an implementation is considered long running.

delete(String) - Static method in class com.helger.photon.api.APIPath

E

EPathDescriptorVariableConstraintType - Enum in com.helger.photon.api.pathdescriptor

This enum contains all the variable constraint types that can be used in API paths.

equals(Object) - Method in class com.helger.photon.api.APIPath

equals(Object) - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

equals(Object) - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

equals(Object) - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

exceptionCallbacks() - Static method in class com.helger.photon.api.APISettings

G

get(String) - Static method in class com.helger.photon.api.APIPath

getAllAPIDescriptors() - Method in class com.helger.photon.api.APIRegistry

getAllAPIDescriptors() - Method in interface com.helger.photon.api.IAPIRegistry

getAllDescriptors() - Method in class com.helger.photon.api.APIDescriptorList

getAllParts() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

getAllPathVariables() - Method in class com.helger.photon.api.InvokableAPIDescriptor

getAllVariableConstraints() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

getAllVariableValues() - Method in class com.helger.photon.api.pathdescriptor.PathMatchingResult

getAPIByPath(APIPath) - Method in interface com.helger.photon.api.IAPIRegistry

Find an InvokableAPIDescriptor that matches the provided path.

getAPIByPath(APIPath, IAPIPathAmbiguityResolver) - Method in class com.helger.photon.api.APIRegistry

getAPIByPath(APIPath, IAPIPathAmbiguityResolver) - Method in interface com.helger.photon.api.IAPIRegistry

Find an InvokableAPIDescriptor that matches the provided path.

getAPIDescriptor() - Method in class com.helger.photon.api.InvokableAPIDescriptor

getAPIPath() - Method in class com.helger.photon.api.APIDescriptor

getAPIPath() - Method in interface com.helger.photon.api.IAPIDescriptor

getAsURLString() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

getAsURLString() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

getAsURLString() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

getCleanPathParts(String) - Static method in class com.helger.photon.api.pathdescriptor.PathDescriptorHelper

Clean the provided path and split it into parts, separated by slashes.

getConstraintType() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

getConstraintValue() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

getExceptionMapper() - Method in class com.helger.photon.api.APIDescriptor

getExceptionMapper() - Method in interface com.helger.photon.api.IAPIDescriptor

getExecutionFilter() - Method in class com.helger.photon.api.APIDescriptor

getExecutionFilter() - Method in interface com.helger.photon.api.IAPIDescriptor

getExecutorFactory() - Method in class com.helger.photon.api.APIDescriptor

getExecutorFactory() - Method in interface com.helger.photon.api.IAPIDescriptor

getFromIDOrNull(String) - Static method in enum com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

getHttpMethod() - Method in class com.helger.photon.api.APIPath

getHttpMethod() - Method in interface com.helger.photon.api.IAPIDescriptor

getID() - Method in enum com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

getInstance() - Static method in class com.helger.photon.api.GlobalAPIInvoker

getInvocationURL(String) - Method in class com.helger.photon.api.APIPath

Get the invocation URL of this API path.

getInvoker() - Method in class com.helger.photon.api.GlobalAPIInvoker

getLongRunningExecutionLimitTime() - Static method in class com.helger.photon.api.APISettings

getMatching(APIPath) - Method in class com.helger.photon.api.APIDescriptorList

getMatching(APIPath, IAPIPathAmbiguityResolver) - Method in class com.helger.photon.api.APIDescriptorList

getName() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

getPath() - Method in class com.helger.photon.api.APIPath

getPath() - Method in class com.helger.photon.api.InvokableAPIDescriptor

getPathDescriptor() - Method in class com.helger.photon.api.APIDescriptor

getPathDescriptor() - Method in interface com.helger.photon.api.IAPIDescriptor

getRegistry() - Method in class com.helger.photon.api.GlobalAPIInvoker

getResponseEntityWithoutStackTrace(Throwable) - Static method in class com.helger.photon.api.AbstractAPIExceptionMapper

getResponseEntityWithStackTrace(Throwable) - Static method in class com.helger.photon.api.AbstractAPIExceptionMapper

getVariableName(String) - Static method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

GlobalAPIInvoker - Class in com.helger.photon.api

Central API manager.

GlobalAPIInvoker() - Constructor for class com.helger.photon.api.GlobalAPIInvoker

Deprecated.

H

handleRequest(IRequestWebScopeWithoutResponse, UnifiedResponse) - Method in class com.helger.photon.api.servlet.APIXServletHandler

hasExceptionMapper() - Method in interface com.helger.photon.api.IAPIDescriptor

hasExecutionFilter() - Method in interface com.helger.photon.api.IAPIDescriptor

hashCode() - Method in class com.helger.photon.api.APIPath

hashCode() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

hashCode() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

hashCode() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

I

IAPIAfterExecutionCallback - Interface in com.helger.photon.api

Callback interface to be used with the IAPIInvoker to get notified after an InvokableAPIDescriptor was invoked.

IAPIBeforeExecutionCallback - Interface in com.helger.photon.api

Callback interface to be used with the IAPIInvoker to get notified before an InvokableAPIDescriptor is invoked.

IAPIDescriptor - Interface in com.helger.photon.api

The read-only part of APIDescriptor.

IAPIExceptionCallback - Interface in com.helger.photon.api

Callback interface to handle thrown but unmapped exception objects from the API servlet.

IAPIExceptionMapper - Interface in com.helger.photon.api

API exception mapper to convert exceptions into reasonable HTTP responses.

IAPIExecutionFilter - Interface in com.helger.photon.api

Generic API execution filter.

IAPIExecutor - Interface in com.helger.photon.api

Interface for API executors.

IAPIInvoker - Interface in com.helger.photon.api

Base interface for an API invoker.

IAPILongRunningExecutionCallback - Interface in com.helger.photon.api

Callback interface to be used with the IAPIInvoker to get notified on long running executions.

IAPIPathAmbiguityResolver - Interface in com.helger.photon.api

Shared interface to resolve API ambiguities.

IAPIRegistry - Interface in com.helger.photon.api

Base interface for an API registry.

InvokableAPIDescriptor - Class in com.helger.photon.api

An InvokableAPIDescriptor contains an IAPIDescriptor as well the original path by which it was called as well as any resolved path variables.

InvokableAPIDescriptor(IAPIDescriptor, String, ICommonsOrderedMap<String, String>) - Constructor for class com.helger.photon.api.InvokableAPIDescriptor

Constructor

invoke(InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, UnifiedResponse) - Method in class com.helger.photon.api.APIInvoker

invoke(InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, UnifiedResponse) - Method in interface com.helger.photon.api.IAPIInvoker

Invoke the specified API

invokeAPI(IAPIDescriptor, String, Map<String, String>, IRequestWebScopeWithoutResponse, UnifiedResponse) - Method in interface com.helger.photon.api.IAPIExecutor

invokeAPI(IRequestWebScopeWithoutResponse, UnifiedResponse) - Method in class com.helger.photon.api.InvokableAPIDescriptor

Invoke the Java callback underlying this API descriptor.

isMatch() - Method in class com.helger.photon.api.pathdescriptor.PathMatchingResult

isRequiresValue() - Method in enum com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

isVariable() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

L

LoggingAPIExceptionCallback - Class in com.helger.photon.api.callback

Implementation of IAPIExceptionCallback logging to an SLF4J logger

LoggingAPIExceptionCallback() - Constructor for class com.helger.photon.api.callback.LoggingAPIExceptionCallback

LoggingAPILongRunningExecutionCallback - Class in com.helger.photon.api.callback

LoggingAPILongRunningExecutionCallback() - Constructor for class com.helger.photon.api.callback.LoggingAPILongRunningExecutionCallback

LoggingAPIPathAmbiguityResolver - Class in com.helger.photon.api

Logging instance of IAPIPathAmbiguityResolver.

LoggingAPIPathAmbiguityResolver() - Constructor for class com.helger.photon.api.LoggingAPIPathAmbiguityResolver

longRunningExecutionCallbacks() - Static method in class com.helger.photon.api.APISettings

M

matches(String) - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

Check if the passed path part matches the requirements of this object.

matches(String) - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

matchesParts(List<String>) - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

Check if this path descriptor matches the provided path parts.

N

NO_MATCH - Static variable in class com.helger.photon.api.pathdescriptor.PathMatchingResult

O

onAfterExecution(IAPIInvoker, InvokableAPIDescriptor, IRequestWebScopeWithoutResponse) - Method in interface com.helger.photon.api.IAPIAfterExecutionCallback

Callback method

onAPIExecutionException(IAPIInvoker, InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, Throwable) - Method in class com.helger.photon.api.callback.LoggingAPIExceptionCallback

onAPIExecutionException(IAPIInvoker, InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, Throwable) - Method in interface com.helger.photon.api.IAPIExceptionCallback

Called when an unmapped exception occurred while executing the server side code.

onBeforeExecution(IAPIInvoker, InvokableAPIDescriptor, IRequestWebScopeWithoutResponse) - Method in interface com.helger.photon.api.IAPIBeforeExecutionCallback

Callback method

onLongRunningExecution(IAPIInvoker, InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, long) - Method in class com.helger.photon.api.callback.LoggingAPILongRunningExecutionCallback

onLongRunningExecution(IAPIInvoker, InvokableAPIDescriptor, IRequestWebScopeWithoutResponse, long) - Method in interface com.helger.photon.api.IAPILongRunningExecutionCallback

Callback method

P

PathDescriptor - Class in com.helger.photon.api.pathdescriptor

This class keeps a list of PathDescriptorPart objects that are created when initially parsing an API path.

PathDescriptorHelper - Class in com.helger.photon.api.pathdescriptor

Utility class for API path handling.

PathDescriptorPart - Class in com.helger.photon.api.pathdescriptor

This class keeps a single path part.

PathDescriptorVariableConstraint - Class in com.helger.photon.api.pathdescriptor

This class keeps a single constraint that maybe used in a PathDescriptorPart object.

PathMatchingResult - Class in com.helger.photon.api.pathdescriptor

This class represents the overall result of a path matching.

PathMatchingResult(ICommonsOrderedMap<String, String>) - Constructor for class com.helger.photon.api.pathdescriptor.PathMatchingResult

Constructor for "match"

PhotonAPIServlet - Class in com.helger.photon.api.servlet

This class handles the API functions for the public application.
The default registration for web.xml looks like this:

PhotonAPIServlet() - Constructor for class com.helger.photon.api.servlet.PhotonAPIServlet

post(String) - Static method in class com.helger.photon.api.APIPath

put(String) - Static method in class com.helger.photon.api.APIPath

R

REGEX - com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

registerAPI(APIDescriptor) - Method in class com.helger.photon.api.APIRegistry

registerAPI(APIDescriptor) - Method in interface com.helger.photon.api.IAPIRegistry

Register a new API descriptor.

requiredHeaders() - Method in class com.helger.photon.api.APIDescriptor

requiredHeaders() - Method in interface com.helger.photon.api.IAPIDescriptor

requiredParams() - Method in class com.helger.photon.api.APIDescriptor

requiredParams() - Method in interface com.helger.photon.api.IAPIDescriptor

resetToDefault() - Method in class com.helger.photon.api.GlobalAPIInvoker

Reset all values to default.

S

SERVLET_DEFAULT_NAME - Static variable in class com.helger.photon.api.servlet.PhotonAPIServlet

SERVLET_DEFAULT_PATH - Static variable in class com.helger.photon.api.servlet.PhotonAPIServlet

setExceptionMapper(IAPIExceptionMapper) - Method in class com.helger.photon.api.APIDescriptor

setExecutionFilter(IAPIExecutionFilter) - Method in class com.helger.photon.api.APIDescriptor

setInvoker(IAPIInvoker) - Method in class com.helger.photon.api.GlobalAPIInvoker

Set the global invoker to be used.

setLongRunningExecutionLimitTime(long) - Static method in class com.helger.photon.api.APISettings

Set the milliseconds after which an execution is considered long running.

setRegistry(IAPIRegistry) - Method in class com.helger.photon.api.GlobalAPIInvoker

Set the global registry to be used.

setSimpleTextResponse(UnifiedResponse, int, String) - Static method in class com.helger.photon.api.AbstractAPIExceptionMapper

T

toString() - Method in class com.helger.photon.api.APIDescriptor

toString() - Method in class com.helger.photon.api.APIDescriptorList

toString() - Method in class com.helger.photon.api.APIInvoker

toString() - Method in class com.helger.photon.api.APIPath

toString() - Method in class com.helger.photon.api.APIRegistry

toString() - Method in class com.helger.photon.api.GlobalAPIInvoker

toString() - Method in class com.helger.photon.api.InvokableAPIDescriptor

toString() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptor

toString() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

toString() - Method in class com.helger.photon.api.pathdescriptor.PathDescriptorVariableConstraint

toString() - Method in class com.helger.photon.api.pathdescriptor.PathMatchingResult

V

valueOf(String) - Static method in enum com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

Returns an array containing the constants of this enum type, in the order they are declared.

VARIABLE_END - Static variable in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

VARIABLE_START - Static variable in class com.helger.photon.api.pathdescriptor.PathDescriptorPart

A B C D E G H I L M N O P R S T V
All Classes All Packages