com.goldencode.p2j.rest

Class RestServiceKey

java.lang.Object

com.goldencode.p2j.rest.ServiceKey

com.goldencode.p2j.rest.RestServiceKey

class RestServiceKey
extends ServiceKey

A key to identify a REST operation by its PATH and VERB.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	address The basepath address.
(package private) java.lang.String	context The context path
(package private) java.lang.String[]	parametersTypes Types of parameters
(package private) java.lang.String	path The defined path.
(package private) java.lang.String[]	paths The path elements.
(package private) java.lang.String	verb The defined verb.

Constructor Summary

Constructors

Constructor and Description
RestServiceKey(java.lang.String basePath, java.lang.String address, java.lang.String path, java.lang.String verb, java.util.List<java.lang.String> types) Create a new key.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildContextPath(java.lang.String basePath, java.lang.String address) Build the rest service context path based on the given rest service base path and address.
boolean	equals(java.lang.Object obj) Check if the given object is the same as this one.
int	hashCode() Calculate the key's hashcode.
java.lang.String	toString() The string representation of this key (the path and verb).

Methods inherited from class java.lang.Object

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

Field Detail

address

final java.lang.String address

The basepath address.

path

final java.lang.String path

The defined path.

verb

final java.lang.String verb

The defined verb.

paths

final java.lang.String[] paths

The path elements.

parametersTypes

final java.lang.String[] parametersTypes

Types of parameters

context

final java.lang.String context

The context path

Constructor Detail

RestServiceKey

public RestServiceKey(java.lang.String basePath,
                      java.lang.String address,
                      java.lang.String path,
                      java.lang.String verb,
                      java.util.List<java.lang.String> types)

Create a new key.

Parameters:

address - The basepath address.

path - The defined path.

verb - The defined verb.

Method Detail

buildContextPath

public static java.lang.String buildContextPath(java.lang.String basePath,
                                                java.lang.String address)

Build the rest service context path based on the given rest service base path and address.

Parameters:

basePath - The rest service bath path

address - The base path of the given rest method

Returns:

The context path

equals

public boolean equals(java.lang.Object obj)

Check if the given object is the same as this one.

Specified by:

equals in class ServiceKey

Parameters:

obj - The object to check for equality.

Returns:

See above.

hashCode

public int hashCode()

Calculate the key's hashcode.

Specified by:

hashCode in class ServiceKey

Returns:

See above.

toString

public java.lang.String toString()

The string representation of this key (the path and verb).

Specified by:

toString in class ServiceKey

Returns:

See above.