Class PKIService

java.lang.Object

com.netscape.cms.servlet.base.PKIService

Direct Known Subclasses:

SubsystemService

public class PKIService
extends Object

Base class for CMS RESTful resources

Author:

alee

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LONG_CACHE_LIFETIME
static final int	DEFAULT_SIZE
protected HttpHeaders	headers
static org.slf4j.Logger	logger
static List<MediaType>	MESSAGE_FORMATS
static final int	MIN_FILTER_LENGTH
protected Request	request
protected jakarta.servlet.ServletContext	servletContext
protected jakarta.servlet.http.HttpServletRequest	servletRequest
protected UriInfo	uriInfo

Constructor Summary

Constructors

Constructor	Description
PKIService()

Method Summary

Modifier and Type	Method	Description
Response	createCreatedResponse(Object entity, URI link)
Response	createNoContentResponse()
Response	createOKResponse()
Response	createOKResponse(Object entity)
CMSEngine	getCMSEngine()
Locale	getLocale(HttpHeaders headers)
Map<String,String>	getParams(Object object)	Get the values of the fields annotated with @Param.
MediaType	getResponseFormat()
static MediaType	getResponseFormat(HttpHeaders headers)
Object	marshall(Object response)	Marshall response object with custom mapping if available.
static MediaType	resolveFormat(List<MediaType> formats)	Find a match from a list of candidate media types (which may be wildcards) against the default list of valid media types.
static MediaType	resolveFormat(List<MediaType> candidates, List<MediaType> validTypes)	Find a match from a list of candidate media types (which may be wildcards) against a list of valid media types.
static MediaType	resolveFormat(MediaType format)	Return a match for a candidate media type (which may be a wildcard) against the default list of valid media types.
static MediaType	resolveFormat(MediaType candidate, List<MediaType> validTypes)	Return a match for a candidate media type (which may be a wildcard) against a list of valid media types.
Response	sendConditionalGetResponse(int ctime, Object entity, Request request)
<T> T	unmarshall(Object request, Class<T> clazz)	Unmarshall request object with custom mapping if available.

Methods inherited from class Object

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

Field Details

logger

public static org.slf4j.Logger logger

DEFAULT_LONG_CACHE_LIFETIME

public static final int DEFAULT_LONG_CACHE_LIFETIME

See Also:

• Constant Field Values

MESSAGE_FORMATS

public static List<MediaType> MESSAGE_FORMATS

MIN_FILTER_LENGTH

public static final int MIN_FILTER_LENGTH

See Also:

• Constant Field Values

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

• Constant Field Values

uriInfo

protected UriInfo uriInfo

headers

protected HttpHeaders headers

request

protected Request request

servletRequest

protected jakarta.servlet.http.HttpServletRequest servletRequest

servletContext

protected jakarta.servlet.ServletContext servletContext

Constructor Details

PKIService

public PKIService()

Method Details

resolveFormat

public static MediaType resolveFormat(MediaType format)

Return a match for a candidate media type (which may be a wildcard) against the default list of valid media types.

Returns:

the matching MediaType or null if no match

resolveFormat

public static MediaType resolveFormat(MediaType candidate,
 List<MediaType> validTypes)

Return a match for a candidate media type (which may be a wildcard) against a list of valid media types.

Returns:

the matching MediaType or null if no match

resolveFormat

public static MediaType resolveFormat(List<MediaType> formats)

Find a match from a list of candidate media types (which may be wildcards) against the default list of valid media types. Candidates are checked in list order. Quality values ("q" parameter) are ignored.

Returns:

the matching MediaType or null if no match

resolveFormat

public static MediaType resolveFormat(List<MediaType> candidates,
 List<MediaType> validTypes)

Find a match from a list of candidate media types (which may be wildcards) against a list of valid media types. Candidates are checked in list order. Quality values ("q" parameter) are ignored.

Returns:

the matching MediaType or null if no match

getResponseFormat

public static MediaType getResponseFormat(HttpHeaders headers)

getResponseFormat

public MediaType getResponseFormat()

createOKResponse

public Response createOKResponse()

marshall

public Object marshall(Object response)

Marshall response object with custom mapping if available. This method is called for by all services. It will use custom mapping if available.

unmarshall

public <T> T unmarshall(Object request,
 Class<T> clazz)

Unmarshall request object with custom mapping if available.

createOKResponse

public Response createOKResponse(Object entity)

createCreatedResponse

public Response createCreatedResponse(Object entity,
 URI link)

createNoContentResponse

public Response createNoContentResponse()

sendConditionalGetResponse

public Response sendConditionalGetResponse(int ctime,
 Object entity,
 Request request)

getLocale

public Locale getLocale(HttpHeaders headers)

getParams

public Map<String,String> getParams(Object object)

Get the values of the fields annotated with @Param.

getCMSEngine

public CMSEngine getCMSEngine()