com.netscape.cms.servlet.base

Class PKIService

java.lang.Object

com.netscape.cms.servlet.base.PKIService

Direct Known Subclasses:

AccountService, AuditService, FeatureService, GroupService, SecurityDomainService, SelfTestService, SystemCertService, SystemConfigService, UserService

public class PKIService
extends java.lang.Object

Base class for CMS RESTful resources

Author:

alee

Field Summary

Fields

Modifier and Type	Field and Description
IAuditor	auditor
protected IAuthzSubsystem	authz
static int	DEFAULT_LONG_CACHE_LIFETIME
static int	DEFAULT_SIZE
protected javax.ws.rs.core.HttpHeaders	headers
ILogger	logger
static java.util.List<javax.ws.rs.core.MediaType>	MESSAGE_FORMATS
static int	MIN_FILTER_LENGTH
protected javax.ws.rs.core.Request	request
protected javax.servlet.ServletContext	servletContext
protected javax.servlet.http.HttpServletRequest	servletRequest
protected javax.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor and Description
PKIService()

Method Summary

Modifier and Type	Method and Description
void	audit(java.lang.String message, java.lang.String scope, java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
void	auditConfigTokenGeneral(java.lang.String status, java.lang.String service, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String info)
javax.ws.rs.core.Response	createCreatedResponse(java.lang.Object entity, java.net.URI link)
javax.ws.rs.core.Response	createNoContentResponse()
javax.ws.rs.core.Response	createOKResponse()
javax.ws.rs.core.Response	createOKResponse(java.lang.Object entity)
java.lang.String	getInstanceDir()
java.util.Locale	getLocale(javax.ws.rs.core.HttpHeaders headers)
java.util.Map<java.lang.String,java.lang.String>	getParams(java.lang.Object object) Get the values of the fields annotated with @FormParam.
java.util.ResourceBundle	getResourceBundle(java.lang.String name)
javax.ws.rs.core.MediaType	getResponseFormat()
static javax.ws.rs.core.MediaType	getResponseFormat(javax.ws.rs.core.HttpHeaders headers)
java.lang.String	getSharedSubsystemConfDir()
java.lang.String	getSubsystemConfDir()
java.lang.String	getSubsystemName()
java.lang.String	getUserMessage(java.lang.String messageId, javax.ws.rs.core.HttpHeaders headers, java.lang.String... params)
void	log(int source, int level, java.lang.String message)
static javax.ws.rs.core.MediaType	resolveFormat(java.util.List<javax.ws.rs.core.MediaType> formats)
static javax.ws.rs.core.MediaType	resolveFormat(javax.ws.rs.core.MediaType format)
javax.ws.rs.core.Response	sendConditionalGetResponse(int ctime, java.lang.Object object, javax.ws.rs.core.Request request)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LONG_CACHE_LIFETIME

public static final int DEFAULT_LONG_CACHE_LIFETIME

See Also:

Constant Field Values

MESSAGE_FORMATS

public static java.util.List<javax.ws.rs.core.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

@Context
protected javax.ws.rs.core.UriInfo uriInfo

headers

@Context
protected javax.ws.rs.core.HttpHeaders headers

request

@Context
protected javax.ws.rs.core.Request request

servletRequest

@Context
protected javax.servlet.http.HttpServletRequest servletRequest

servletContext

@Context
protected javax.servlet.ServletContext servletContext

authz

protected IAuthzSubsystem authz

logger

public ILogger logger

auditor

public IAuditor auditor

Constructor Detail

PKIService

public PKIService()

Method Detail

getInstanceDir

public java.lang.String getInstanceDir()

getSubsystemName

public java.lang.String getSubsystemName()

getSubsystemConfDir

public java.lang.String getSubsystemConfDir()

getSharedSubsystemConfDir

public java.lang.String getSharedSubsystemConfDir()

getResourceBundle

public java.util.ResourceBundle getResourceBundle(java.lang.String name)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

resolveFormat

public static javax.ws.rs.core.MediaType resolveFormat(javax.ws.rs.core.MediaType format)

resolveFormat

public static javax.ws.rs.core.MediaType resolveFormat(java.util.List<javax.ws.rs.core.MediaType> formats)

getResponseFormat

public static javax.ws.rs.core.MediaType getResponseFormat(javax.ws.rs.core.HttpHeaders headers)

getResponseFormat

public javax.ws.rs.core.MediaType getResponseFormat()

createOKResponse

public javax.ws.rs.core.Response createOKResponse()

createOKResponse

public javax.ws.rs.core.Response createOKResponse(java.lang.Object entity)

createCreatedResponse

public javax.ws.rs.core.Response createCreatedResponse(java.lang.Object entity,
                                                       java.net.URI link)

createNoContentResponse

public javax.ws.rs.core.Response createNoContentResponse()

sendConditionalGetResponse

public javax.ws.rs.core.Response sendConditionalGetResponse(int ctime,
                                                            java.lang.Object object,
                                                            javax.ws.rs.core.Request request)

getLocale

public java.util.Locale getLocale(javax.ws.rs.core.HttpHeaders headers)

getUserMessage

public java.lang.String getUserMessage(java.lang.String messageId,
                                       javax.ws.rs.core.HttpHeaders headers,
                                       java.lang.String... params)

log

public void log(int source,
                int level,
                java.lang.String message)

audit

public void audit(java.lang.String message,
                  java.lang.String scope,
                  java.lang.String type,
                  java.lang.String id,
                  java.util.Map<java.lang.String,java.lang.String> params,
                  java.lang.String status)

auditConfigTokenGeneral

public void auditConfigTokenGeneral(java.lang.String status,
                                    java.lang.String service,
                                    java.util.Map<java.lang.String,java.lang.String> params,
                                    java.lang.String info)

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams(java.lang.Object object)

Get the values of the fields annotated with @FormParam.