Skip navigation links

oracle.irm.engine.rights.context
Interface Domain

public interface Domain

Domain. A domain is a way of organizing security policies relating to Context based classifications. A domain owns a set of document roles and context templates. The document roles are for use within this domain with. Each Context will have associated with it all or a sub-set of these roles for assignment to accounts. Context templates can be used to create Context classification instances with a well defined structure. e.g. defining which roles are available for use within a Context.

Creation

Instances of Domain objects can be created using the following factory style method(s).

Domain object = createDomain(uuid);

Domain object = createDomain(
    uuid,
    labels);

Collections

Collections for Domain objects can be created using the following factory method. This method creates the most appropriate collection implementation class for storing Domain elements.

 Collection<Domain> object = createDomains();

Consult the Uuid property for more information on how this property can relate to Domain collections.

XML Serialization

Domain instances can be serialized as an XML document. This XML document can also be used to recreate a Domain object. The following XML document shows an example Domain in XML form.

<?xml version="1.0" encoding="UTF-8"?>
<rights:Domain xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>021d94da-3b5b-41c3-afb0-55135a7e5321</uuid>
<labels>
<locale>en</locale>
<name>Acme</name>
<description>This is a domain for ACME.</description>
</labels>
</rights:Domain>

Domain instances can also be serialized by reference. A reference contains all the information needed to uniquely identify a Domain without needing to serialize the complete object. The reference form of the XML document can be seen below.

<?xml version="1.0" encoding="UTF-8"?>
<rights:DomainRef xmlns:rights="http://xmlns.oracle.com/irm/rights">
<uuid>021d94da-3b5b-41c3-afb0-55135a7e5321</uuid>
</rights:DomainRef>

Nested Class Summary

static class

Domain.Role Roles that user's can have within a domain.

Method Summary

Collection<Label>	getLabels() Domain labels.
UUID	getUuid() The UUID of the domain.

Method Detail

getUuid

UUID getUuid()

The UUID of the domain. Any domain can be uniquely identified by it's UUID.

Collections

This property value can be used to retrieve the object from a collection using getDomainByUuid.

Returns:

the value of the property. This method will never return null.

getLabels

Collection<Label> getLabels()

Domain labels. A set of labels for this domain.

State

The collection returned by this method is an unmodifiable view on the internal collection state of the object.

Returns:

the value of the property. If this collection is empty this method returns an empty collection rather than returning null.

Skip navigation links