org.forgerock.openam.xacml.v3.rest

Class XacmlService

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.forgerock.openam.xacml.v3.rest.XacmlService

public class XacmlService
extends org.restlet.resource.ServerResource

Provides XACML based services

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERY_PARAM_STRING

Constructor Summary

Constructors

Constructor and Description
XacmlService(XACMLExportImport importExport, PrivilegedAction<SSOToken> adminTokenAction, Debug debug, RestLog restLog, DelegationEvaluator evaluator, JacksonRepresentationFactory jacksonRepresentationFactory) Constructor with dependencies exposed for unit testing.

Method Summary

Modifier and Type	Method and Description
org.restlet.representation.Representation	exportXACML() Export all Policies defined within the Realm used to access this end point.
org.restlet.representation.Representation	importXACML(org.restlet.representation.Representation entity) Expects to receive XACML formatted XML which will be read and imported.

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doHandle, doNegotiatedHandle, get, get, getAnnotation, getAnnotation, getAnnotations, getAttribute, getDescription, getInfo, getInfo, getName, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDescription, setDimensions, setExisting, setLocationRef, setLocationRef, setName, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doInit, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_PARAM_STRING

public static final String QUERY_PARAM_STRING

See Also:

Constant Field Values

Constructor Detail

XacmlService

@Inject
public XacmlService(XACMLExportImport importExport,
                            PrivilegedAction<SSOToken> adminTokenAction,
                            @Named(value="frRest")
                            Debug debug,
                            RestLog restLog,
                            DelegationEvaluator evaluator,
                            JacksonRepresentationFactory jacksonRepresentationFactory)

Constructor with dependencies exposed for unit testing.

Parameters:

importExport - Non null utility functions.

adminTokenAction - Non null admin action function.

debug - The debug instance for logging.

jacksonRepresentationFactory - The factory for JacksonRepresentation instances.

Method Detail

importXACML

@Post
public org.restlet.representation.Representation importXACML(org.restlet.representation.Representation entity)

Expects to receive XACML formatted XML which will be read and imported.

exportXACML

@Get
public org.restlet.representation.Representation exportXACML()

Export all Policies defined within the Realm used to access this end point. The end point supports the query parameter "filter" which can be used multiple times to define the Search Filters which will restrict the output to only those Privileges which match the Search Filters. See SearchFilterFactory for more details on the format of these Search Filters.

Returns:

XACML of the matching Privileges.