Package com.helger.photon.api

Class APIPath

java.lang.Object

com.helger.photon.api.APIPath

All Implemented Interfaces:

Serializable

@Immutable
@MustImplementEqualsAndHashcode
public class APIPath
extends Object
implements Serializable

This class contains a combination of path and HTTP method.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
APIPath(com.helger.commons.http.EHttpMethod eHttpMethod, String sPath)	Constructor

Method Summary

Modifier and Type	Method	Description
static APIPath	createForFilter(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)
static APIPath	createForServlet(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)
static APIPath	delete(String sPath)
boolean	equals(Object o)
static APIPath	get(String sPath)
com.helger.commons.http.EHttpMethod	getHttpMethod()
com.helger.commons.url.SimpleURL	getInvocationURL(String sBasePath)	Get the invocation URL of this API path.
String	getPath()
int	hashCode()
static APIPath	post(String sPath)
static APIPath	put(String sPath)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

APIPath

public APIPath(@Nonnull
               com.helger.commons.http.EHttpMethod eHttpMethod,
               @Nonnull @Nonempty
               String sPath)

Constructor

Parameters:

eHttpMethod - The HTTP method to be used. May not be null.

sPath - The path relative to the owning servlet.

Method Detail

getHttpMethod

@Nonnull
public com.helger.commons.http.EHttpMethod getHttpMethod()

Returns:

The HTTP method as provided in the constructor. Never null.

getPath

@Nonnull
@Nonempty
public String getPath()

Returns:

The path as provided in the constructor. Neither null nor empty.

getInvocationURL

@Nonnull
public com.helger.commons.url.SimpleURL getInvocationURL(@Nonnull
                                                         String sBasePath)

Get the invocation URL of this API path.

Parameters:

sBasePath - The HTTP base path of the server (e.g. http://www.example.org/api"), which is prepended to the relative path of this object. May not be null but maybe empty (since v8.1.4)

Returns:

The new URL. Never null.

See Also:

getPath()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

get

@Nonnull
public static APIPath get(@Nonnull @Nonempty
                          String sPath)

post

@Nonnull
public static APIPath post(@Nonnull @Nonempty
                           String sPath)

put

@Nonnull
public static APIPath put(@Nonnull @Nonempty
                          String sPath)

delete

@Nonnull
public static APIPath delete(@Nonnull @Nonempty
                             String sPath)

createForFilter

@Nonnull
public static APIPath createForFilter(@Nonnull
                                      com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

createForServlet

@Nonnull
public static APIPath createForServlet(@Nonnull
                                       com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)