org.apache.sis.metadata.iso.constraint

Class DefaultSecurityConstraints

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultConstraints

DefaultSecurityConstraints

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, Constraints, SecurityConstraints

public class DefaultSecurityConstraints
extends DefaultConstraints
implements SecurityConstraints

Handling restrictions imposed on the resource for national security or similar security concerns. The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Security­Constraints └─classification………… Name of the handling restrictions on the resource.

Limitations:

• Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
• Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.

Since:

0.3

See Also:

Serialized Form

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor and Description
DefaultSecurityConstraints() Creates an initially empty security constraints.
DefaultSecurityConstraints(CharSequence useLimitation) Constructs a new constraints with the given use limitation.
DefaultSecurityConstraints(Classification classification) Creates a security constraints initialized with the specified classification.
DefaultSecurityConstraints(SecurityConstraints object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method and Description
static DefaultSecurityConstraints	castOrCopy(SecurityConstraints object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Classification	getClassification() Returns the name of the handling restrictions on the resource.
InternationalString	getClassificationSystem() Returns the name of the classification system.
InternationalString	getHandlingDescription() Returns the additional information about the restrictions on handling the resource.
InternationalString	getUserNote() Returns the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.
void	setClassification(Classification newValue) Sets the name of the handling restrictions on the resource.
void	setClassificationSystem(InternationalString newValue) Sets the name of the classification system.
void	setHandlingDescription(InternationalString newValue) Sets the additional information about the restrictions on handling the resource.
void	setUserNote(InternationalString newValue) Sets the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.

Methods inherited from class DefaultConstraints

cast­Or­Copy, get­Constraint­Application­Scope, get­Graphics, get­References, get­Releasability, get­Responsible­Parties, get­Use­Limitations, set­Constraint­Application­Scope, set­Graphics, set­References, set­Releasability, set­Responsible­Parties, set­Use­Limitations

Methods inherited from class ISOMetadata

freeze, get­Identifier­Map, get­Identifiers, get­Standard

Methods inherited from class ModifiableMetadata

check­Write­Permission, clone, collection­Type, copy­Collection, copy­List, copy­Set, is­Modifiable, non­Null­Collection, non­Null­List, non­Null­Set, singleton, unmodifiable, write­Collection, write­List, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface Constraints

get­Use­Limitations

Constructor Detail

DefaultSecurityConstraints

public DefaultSecurityConstraints()

Creates an initially empty security constraints.

DefaultSecurityConstraints

public DefaultSecurityConstraints(CharSequence useLimitation)

Constructs a new constraints with the given use limitation.

Parameters:

use­Limitation - the use limitation, or null if none.

DefaultSecurityConstraints

public DefaultSecurityConstraints(Classification classification)

Creates a security constraints initialized with the specified classification.

Parameters:

classification - the name of the handling restrictions on the resource, or null.

DefaultSecurityConstraints

public DefaultSecurityConstraints(SecurityConstraints object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

cast­Or­Copy(Security­Constraints)

Method Detail

castOrCopy

public static DefaultSecurityConstraints castOrCopy(SecurityConstraints object)

Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:

• If the given object is null, then this method returns null.
• Otherwise if the given object is already an instance of Default­Security­Constraints, then it is returned unchanged.
• Otherwise a new Default­Security­Constraints instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since the other metadata contained in the given object are not recursively copied.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

getClassification

public Classification getClassification()

Returns the name of the handling restrictions on the resource.

Specified by:

get­Classification in interface Security­Constraints

Returns:

name of the handling restrictions on the resource, or null.

setClassification

public void setClassification(Classification newValue)

Sets the name of the handling restrictions on the resource.

Parameters:

new­Value - the new classification.

getUserNote

public InternationalString getUserNote()

Returns the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.

Specified by:

get­User­Note in interface Security­Constraints

Returns:

explanation of the application of the legal constraints, or null.

setUserNote

public void setUserNote(InternationalString newValue)

Sets the explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource.

Parameters:

new­Value - the new user note.

getClassificationSystem

public InternationalString getClassificationSystem()

Returns the name of the classification system.

Specified by:

get­Classification­System in interface Security­Constraints

Returns:

name of the classification system, or null.

setClassificationSystem

public void setClassificationSystem(InternationalString newValue)

Sets the name of the classification system.

Parameters:

new­Value - the new classification system.

getHandlingDescription

public InternationalString getHandlingDescription()

Returns the additional information about the restrictions on handling the resource.

Specified by:

get­Handling­Description in interface Security­Constraints

Returns:

additional information about the restrictions, or null.

setHandlingDescription

public void setHandlingDescription(InternationalString newValue)

Sets the additional information about the restrictions on handling the resource.

Parameters:

new­Value - the new handling description.