Package org.openmetadata.service.resources.policies

Class PolicyResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Policy,PolicyRepository>

org.openmetadata.service.resources.policies.PolicyResource

@Path("/v1/policies")
@Produces("application/json")
@Consumes("application/json")
public class PolicyResource
extends EntityResource<Policy,PolicyRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PolicyResource.PolicyList
static class	PolicyResource.ResourceDescriptorList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_PATH
static final String	FIELDS

Fields inherited from class org.openmetadata.service.resources.EntityResource

allowedFields, authorizer, entityClass, entityType, fieldsToViewOperations, repository, VIEW_ALL_OPERATIONS, VIEW_BASIC_OPERATIONS

Constructor Summary

Constructors

Constructor	Description
PolicyResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
Policy	addHref(javax.ws.rs.core.UriInfo uriInfo, Policy policy)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreatePolicy create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreatePolicy create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String fqn)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, UUID id)
Policy	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Policy	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
Policy	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
void	initialize(OpenMetadataApplicationConfig config)	Method used for initializing a resource, such as creating default policies, roles, etc.
@Valid ResultList<Policy>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
ResultList<Function>	listPolicyFunctions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
ResultList<ResourceDescriptor>	listPolicyResources(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restorePolicy(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
void	upgrade()	Method used for upgrading a resource such as adding new fields to entities, etc.
void	validateCondition(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String expression)

Methods inherited from class org.openmetadata.service.resources.EntityResource

addHref, addViewOperation, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, listInternal, listInternal, listVersionsInternal, listVersionsInternal, patchInternal, restoreEntity

Methods inherited from class java.lang.Object

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

Field Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

FIELDS

public static final String FIELDS

See Also:

• Constant Field Values

Constructor Details

PolicyResource

public PolicyResource(Authorizer authorizer)

Method Details

addHref

public Policy addHref(javax.ws.rs.core.UriInfo uriInfo,
 Policy policy)

Overrides:

addHref in class EntityResource<Policy,PolicyRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Policy,PolicyRepository>

initialize

public void initialize(OpenMetadataApplicationConfig config)
                throws IOException

Description copied from class: EntityResource

Method used for initializing a resource, such as creating default policies, roles, etc.

Overrides:

initialize in class EntityResource<Policy,PolicyRepository>

Throws:

IOException

upgrade

public void upgrade()

Description copied from class: EntityResource

Method used for upgrading a resource such as adding new fields to entities, etc. that can't be done in bootstrap migrate

Overrides:

upgrade in class EntityResource<Policy,PolicyRepository>

list

@GET
@Valid
public @Valid ResultList<Policy> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @DefaultValue("10") @Min(0L) @Max(1000000L) @QueryParam("limit")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
 @QueryParam("before")
 String before,
 @QueryParam("after")
 String after,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

get

@GET
@Path("/{id}")
public Policy get(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

getByName

@GET
@Path("/name/{fqn}")
public Policy getByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("fqn")
 String fqn,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

listVersions

@GET
@Path("/{id}/versions")
public EntityHistory listVersions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Policy getVersion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @PathParam("version")
 String version)

listPolicyResources

@GET
@Path("/resources")
public ResultList<ResourceDescriptor> listPolicyResources(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext)

listPolicyFunctions

@GET
@Path("/functions")
public ResultList<Function> listPolicyFunctions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext)

create

@POST
public javax.ws.rs.core.Response create(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreatePolicy create)

patch

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patch(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 javax.json.JsonPatch patch)

createOrUpdate

@PUT
public javax.ws.rs.core.Response createOrUpdate(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreatePolicy create)

delete

@DELETE
@Path("/{id}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @PathParam("id")
 UUID id)

delete

@DELETE
@Path("/name/{fqn}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @PathParam("fqn")
 String fqn)

restorePolicy

@PUT
@Path("/restore")
public javax.ws.rs.core.Response restorePolicy(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid RestoreEntity restore)

validateCondition

@GET
@Path("/validation/condition/{expression}")
public void validateCondition(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("expression")
 String expression)