com.unboundid.scim2.client.ScimInterface Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim2-sdk-client Show documentation
Show all versions of scim2-sdk-client Show documentation
The UnboundID SCIM2 SDK is a library that may be used to interact with various
types of SCIM-enabled endpoints (such as the Ping Identity server products) to
perform lightweight, cloud-based identity management via the SCIM Protocol.
See https://simplecloud.info for more information.
The newest version!
/*
* Copyright 2015-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim2.client;
import com.unboundid.scim2.common.ScimResource;
import com.unboundid.scim2.common.annotations.NotNull;
import com.unboundid.scim2.common.annotations.Nullable;
import com.unboundid.scim2.common.exceptions.ScimException;
import com.unboundid.scim2.common.messages.ListResponse;
import com.unboundid.scim2.common.messages.PatchRequest;
import com.unboundid.scim2.common.types.ResourceTypeResource;
import com.unboundid.scim2.common.types.SchemaResource;
import com.unboundid.scim2.common.types.ServiceProviderConfigResource;
/**
* Interface providing a way to create, retrieve, update and delete
* SCIM resources.
*/
public interface ScimInterface
{
/**
* Retrieve the service provider configuration.
*
* @return the service provider configuration.
* @throws ScimException if an error occurs.
*/
@NotNull
ServiceProviderConfigResource getServiceProviderConfig()
throws ScimException;
/**
* Retrieve the resource types supported by the service provider.
*
* @return The list of resource types supported by the service provider.
* @throws ScimException if an error occurs.
*/
@NotNull
ListResponse getResourceTypes()
throws ScimException;
/**
* Retrieve a known resource type supported by the service provider.
*
* @param name The name of the resource type.
* @return The resource type with the provided name.
* @throws ScimException if an error occurs.
*/
@NotNull
ResourceTypeResource getResourceType(@NotNull String name)
throws ScimException;
/**
* Retrieve the schemas supported by the service provider.
*
* @return The list of schemas supported by the service provider.
* @throws ScimException if an error occurs.
*/
@NotNull
ListResponse getSchemas()
throws ScimException;
/**
* Retrieve a known schema supported by the service provider.
*
* @param id The schema URN.
* @return The resource type with the provided URN.
* @throws ScimException if an error occurs.
*/
@NotNull
SchemaResource getSchema(@NotNull String id)
throws ScimException;
/**
* Create the provided new SCIM resource at the service provider.
*
* @param endpoint The resource endpoint such as: "{@code Users}" or
* "{@code Groups}" as defined by the associated resource
* type.
* @param resource The new resource to create.
* @param The Java type of the resource.
* @return The successfully create SCIM resource.
* @throws ScimException if an error occurs.
*/
@NotNull
T create(@NotNull String endpoint,
@NotNull T resource)
throws ScimException;
/**
* Retrieve a known SCIM resource from the service provider.
*
* @param endpoint The resource endpoint such as: "{@code Users}" or
* "{@code Groups}" as defined by the associated resource
* type.
* @param id The resource identifier (for example the value of the "{@code id}"
* attribute).
* @param cls The Java class object used to determine the type to return.
* @param The Java type of the resource.
* @return The successfully retrieved SCIM resource.
* @throws ScimException if an error occurs.
*/
@NotNull
T retrieve(@NotNull String endpoint,
@NotNull String id,
@NotNull Class cls)
throws ScimException;
/**
* Retrieve a known SCIM resource from the service provider. If the
* service provider supports resource versioning and the resource has not been
* modified, the provided resource will be returned.
*
* @param resource The resource to retrieve.
* @param The Java type of the resource.
* @return The successfully retrieved SCIM resource.
* @throws ScimException if an error occurs.
*/
@NotNull
T retrieve(@NotNull T resource)
throws ScimException;
/**
* Modify a SCIM resource by replacing the resource's attributes at the
* service provider. If the service provider supports resource versioning,
* the resource will only be modified if it has not been modified since it
* was retrieved.
*
* @param resource The previously retrieved and revised resource.
* @param The Java type of the resource.
* @return The successfully replaced SCIM resource.
* @throws ScimException if an error occurs.
*/
@NotNull
T replace(@NotNull T resource)
throws ScimException;
/**
* Modify a SCIM resource by updating one or more attributes using a sequence
* of operations to "{@code add}", "{@code remove}", or "{@code replace}"
* values. The service provider configuration may be used to discover service
* provider support for PATCH.
*
* @param endpoint The resource endpoint such as: "{@code Users}" or
* "{@code Groups}" as defined by the associated resource
* type.
* @param id The resource identifier (for example the value of the "{@code id}"
* attribute).
* @param patchRequest The patch request to use for the update.
* @param clazz The class of the SCIM resource.
* @param The Java type of the resource.
*
* @return The modified resource.
* @throws ScimException if an error occurs.
*/
@NotNull
T modify(@NotNull String endpoint,
@NotNull String id,
@NotNull PatchRequest patchRequest,
@NotNull Class clazz)
throws ScimException;
/**
* Modify a SCIM resource by updating one or more attributes using a sequence
* of operations to "{@code add}", "{@code remove}", or "{@code replace}"
* values. The service provider configuration may be used to discover service
* provider support for PATCH.
*
* @param resource The resource to modify.
* @param patchRequest the patch request to use for the update.
* @param The Java type of the resource.
* @return The modified resource.
* @throws ScimException if an error occurs.
*/
@NotNull
T modify(@NotNull T resource,
@NotNull PatchRequest patchRequest)
throws ScimException;
/**
* Delete a SCIM resource at the service provider.
*
* @param endpoint The resource endpoint such as: "{@code Users}" or
* "{@code Groups}" as defined by the associated resource
* type.
* @param id The resource identifier (for example the value of the "{@code id}"
* attribute).
* @throws ScimException if an error occurs.
*/
void delete(@NotNull String endpoint, @NotNull String id)
throws ScimException;
/**
* Delete a SCIM resource at the service provider.
*
* @param resource The resource to delete.
* @param The Java type of the resource.
* @throws ScimException if an error occurs.
*/
void delete(@NotNull T resource)
throws ScimException;
/**
* Search for SCIM resources matching the SCIM filter provided.
*
* @param endpoint a SCIM resource type endpoint.
* @param filter a SCIM filter string.
* @param clazz the class representing the type of the SCIM resource.
* @param The SCIM resource type to return a list of.
* @return a List of ScimResource objects matching the provided filter.
* @throws ScimException if an error occurs.
*/
@NotNull
ListResponse search(@NotNull String endpoint,
@Nullable String filter,
@NotNull Class clazz)
throws ScimException;
}