Package io.jans.scim.ws.rs.scim2

Class BaseScimWebService

java.lang.Object

io.jans.scim.ws.rs.scim2.BaseScimWebService

Direct Known Subclasses:

BulkWebService, Fido2DeviceWebService, GroupWebService, ResourceTypeWS, SchemaWebService, ScimResourcesUpdatedWebService, SearchResourcesWebService, ServiceProviderConfigWS, UserWebService

@Dependent
public class BaseScimWebService
extends Object

Base methods for SCIM web services

Author:

Yuriy Movchan Date: 08/23/2013 Re-engineered by jgomer on 2017-09-14.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SEARCH_SUFFIX

Constructor Summary

Constructors

Constructor	Description
BaseScimWebService()

Method Summary

Modifier and Type	Method	Description
protected void	assignMetaInformation(BaseScimResource resource)
protected void	executeValidation(BaseScimResource resource)
protected void	executeValidation(BaseScimResource resource, boolean laxRequiredness)
String	getEndpointUrl()
static jakarta.ws.rs.core.Response	getErrorResponse(int statusCode, ErrorScimType scimType, String detail)
static jakarta.ws.rs.core.Response	getErrorResponse(jakarta.ws.rs.core.Response.Status status, ErrorScimType scimType, String detail)
static jakarta.ws.rs.core.Response	getErrorResponse(jakarta.ws.rs.core.Response.Status status, String detail)
protected void	init(Class<? extends BaseScimWebService> cls)
protected jakarta.ws.rs.core.Response	inspectPatchRequest(PatchRequest patch, Class<? extends BaseScimResource> cls)
jakarta.ws.rs.core.Response	notFoundResponse(String id, String resourceType)
protected jakarta.ws.rs.core.Response	prepareSearchRequest(List<String> schemas, String filter, String sortBy, String sortOrder, Integer startIndex, Integer count, String attrsList, String excludedAttrsList, SearchRequest request)
jakarta.ws.rs.core.Response	validateExistenceOfUser(String id)

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_SUFFIX

public static final String SEARCH_SUFFIX

See Also:

Constant Field Values

Constructor Detail

BaseScimWebService

public BaseScimWebService()

Method Detail

getEndpointUrl

public String getEndpointUrl()

notFoundResponse

public jakarta.ws.rs.core.Response notFoundResponse(String id,
                                                    String resourceType)

getErrorResponse

public static jakarta.ws.rs.core.Response getErrorResponse(jakarta.ws.rs.core.Response.Status status,
                                                           String detail)

getErrorResponse

public static jakarta.ws.rs.core.Response getErrorResponse(jakarta.ws.rs.core.Response.Status status,
                                                           ErrorScimType scimType,
                                                           String detail)

getErrorResponse

public static jakarta.ws.rs.core.Response getErrorResponse(int statusCode,
                                                           ErrorScimType scimType,
                                                           String detail)

validateExistenceOfUser

public jakarta.ws.rs.core.Response validateExistenceOfUser(String id)
                                                    throws Exception

Throws:

Exception

init

protected void init(Class<? extends BaseScimWebService> cls)

assignMetaInformation

protected void assignMetaInformation(BaseScimResource resource)

executeValidation

protected void executeValidation(BaseScimResource resource)
                          throws SCIMException

Throws:

SCIMException

executeValidation

protected void executeValidation(BaseScimResource resource,
                                 boolean laxRequiredness)
                          throws SCIMException

Throws:

SCIMException

prepareSearchRequest

protected jakarta.ws.rs.core.Response prepareSearchRequest(List<String> schemas,
                                                           String filter,
                                                           String sortBy,
                                                           String sortOrder,
                                                           Integer startIndex,
                                                           Integer count,
                                                           String attrsList,
                                                           String excludedAttrsList,
                                                           SearchRequest request)

inspectPatchRequest

protected jakarta.ws.rs.core.Response inspectPatchRequest(PatchRequest patch,
                                                          Class<? extends BaseScimResource> cls)