AccessPolicy (gCube Resources 5.2.0-SNAPSHOT API)

All Superinterfaces:

org.gcube.informationsystem.base.reference.Element, GCubeProperty, org.gcube.informationsystem.model.reference.ModelElement, org.gcube.informationsystem.model.reference.properties.Property, org.gcube.informationsystem.base.reference.properties.PropertyElement, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable

All Known Implementing Classes:

AccessPolicyImpl
```
@TypeMetadata(name="AccessPolicy",
              description="AccessPolicy carries a free-form access policy expression, plus an accompanying human-readable note, attached to a resource.",
              version="1.1.0")
@Change(version="1.1.0",description="Replaced complex ValueSchema property for \'policy\' with a clean, flat String representation.") @Change(version="1.0.0",description="First Version")
public interface AccessPolicy
extends GCubeProperty
```
AccessPolicy carries a free-form access policy expression, plus an accompanying human-readable note, attached to a resource.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields
Modifier and Type Field Description

static String NAME
The name associated with this property

static String VERSION
The version associated with this property
- Fields inherited from interface org.gcube.informationsystem.base.reference.Element
  DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER
- Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement
  EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static AccessPolicy`	`getDefaultInstance()`	Returns a default instance of AccessPolicy
`String`	`getNote()`	A note associated with the access policy
`String`	`getPolicy()`	The access policy.
`void`	`setNote(String note)`	Sets a note associated with the access policy
`void`	`setPolicy(String policy)`	Sets the access policy

Methods inherited from interface org.gcube.informationsystem.base.reference.Element
getTypeName

Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement
getExpectedType, getSupertypes

Methods inherited from interface org.gcube.informationsystem.model.reference.properties.Property
getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

- Field Detail
  - NAME
```
static final String NAME
```
    The name associated with this property
    
    See Also:
    
    Constant Field Values
  - VERSION
```
static final String VERSION
```
    The version associated with this property
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDefaultInstance
```
static AccessPolicy getDefaultInstance()
```
    Returns a default instance of AccessPolicy
    
    Returns:
    
    a default instance of AccessPolicy
  - getPolicy
```
@ISProperty(description="The access policy.")
String getPolicy()
```
    The access policy. Deliberately unconstrained: accepts any JSON-compatible value (string, number, object, array, ...) since the concrete shape of a policy expression is not known in advance. The Java API always exposes it as a String.
    
    Returns:
    
    the access policy
  - setPolicy
```
void setPolicy(String policy)
```
    Sets the access policy
    
    Parameters:
    
    policy - the access policy
  - getNote
```
@ISProperty(description="A note associated with the access policy.")
String getNote()
```
    A note associated with the access policy
    
    Returns:
    
    the note
  - setNote
```
void setNote(String note)
```
    Sets a note associated with the access policy
    
    Parameters:
    
    note - the note