com.centrasite.resourceaccess.resources
Interface ResourceAccessType

All Known Subinterfaces:
CentraSiteGroup, CentraSitePermission, CentraSiteRole, CentraSiteUser

public interface ResourceAccessType

Defines some basic methods to operate on the underlying CentraSiteRegistryObject.


Method Summary
 void addAssociations(java.util.Collection<javax.xml.registry.infomodel.Association> associations)
           
 void addClassifications(java.util.Collection<javax.xml.registry.infomodel.Classification> classifications)
           
 void addExternalLinks(java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externalLinks)
           
 void addSlots(java.util.Collection<javax.xml.registry.infomodel.Slot> slots)
           
 java.util.Collection<javax.xml.registry.infomodel.Association> getAssociations()
           
 java.util.Collection<javax.xml.registry.infomodel.Classification> getClassifications()
           
 javax.xml.registry.infomodel.InternationalString getDescription()
          Get the description of this object.
 javax.xml.registry.infomodel.InternationalString getDisplayName()
          Get the display name of this object.
 java.util.Collection<javax.xml.registry.infomodel.ExternalLink> getExternalLinks()
           
 java.util.Properties getExternalProperties()
          Provides read-only access to external repository properties.
 java.lang.String getId()
          Internally used.
 java.util.Properties getProperties()
          Deprecated. Use getSlots()
 java.util.Collection<javax.xml.registry.infomodel.Slot> getSlots()
           
 java.util.Collection<javax.xml.registry.infomodel.Key> preDelete()
          This method performs delete without actually persisting the data.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> preSave()
          This method performs save without actually persisting the data.
 void removeAssociations(java.util.Collection<javax.xml.registry.infomodel.Association> associations)
           
 void removeClassifications(java.util.Collection<javax.xml.registry.infomodel.Classification> classifications)
           
 void removeExternalLinks(java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externalLinks)
           
 void removeProperties(java.util.Properties properties)
          Deprecated. Use removeSlots(Collection)
 void removeSlots(java.util.Collection<java.lang.String> slotNames)
           
 void setDescription(javax.xml.registry.infomodel.InternationalString description)
          Set the description of this object.
 void setDisplayName(javax.xml.registry.infomodel.InternationalString displayName)
          Set the display name of this object.
 void setProperties(java.util.Properties properties)
          Deprecated. Use addSlots(Collection)
 void synchronizeProperties()
          Synchronize external repository properties with the respective Registry Object properties, using a predefined mapping between them.
 

Method Detail

getId

java.lang.String getId()
Internally used.


getDisplayName

javax.xml.registry.infomodel.InternationalString getDisplayName()
                                                                throws javax.xml.registry.JAXRException
Get the display name of this object.

Returns:
InternationalString the display name of this object.
Throws:
javax.xml.registry.JAXRException

setDisplayName

void setDisplayName(javax.xml.registry.infomodel.InternationalString displayName)
Set the display name of this object.

Parameters:
displayName - InternationalString the display name of this object.

getDescription

javax.xml.registry.infomodel.InternationalString getDescription()
Get the description of this object.

Returns:
InternationalString the description of this object.

setDescription

void setDescription(javax.xml.registry.infomodel.InternationalString description)
Set the description of this object.

Parameters:
description - InternationalString the description of this object.

getProperties

java.util.Properties getProperties()
Deprecated. Use getSlots()

Get properties available out of the respective registry object slots.

Returns:
Collection slots mapped as key/values pairs using properties collection or empty collection if none.

setProperties

void setProperties(java.util.Properties properties)
                   throws javax.xml.registry.JAXRException,
                          com.softwareag.security.jaas.principals.SagGeneralSecurityException
Deprecated. Use addSlots(Collection)

Set properties as JAXR slots.

Parameters:
properties - The properties collection to be set.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

removeProperties

void removeProperties(java.util.Properties properties)
                      throws javax.xml.registry.JAXRException
Deprecated. Use removeSlots(Collection)

Remove properties i.e. slots from JAXR.

Parameters:
properties - The properties collection to be removed.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs

synchronizeProperties

void synchronizeProperties()
                           throws java.lang.Exception
Synchronize external repository properties with the respective Registry Object properties, using a predefined mapping between them. NOTE: It doesn't save the registry object, just modifies it.

Throws:
java.lang.Exception

getExternalProperties

java.util.Properties getExternalProperties()
                                           throws com.softwareag.security.jaas.principals.SagGeneralSecurityException
Provides read-only access to external repository properties.

Returns:
Return copy of all properties available or empty properties collection if no properties available (either no properties declared in external repository or this instance does not have representation in external repository)
Throws:
com.softwareag.security.jaas.principals.SagGeneralSecurityException

addAssociations

void addAssociations(java.util.Collection<javax.xml.registry.infomodel.Association> associations)
                     throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.addAssociations(Collection)

getAssociations

java.util.Collection<javax.xml.registry.infomodel.Association> getAssociations()
                                                                               throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.getAssociations()

removeAssociations

void removeAssociations(java.util.Collection<javax.xml.registry.infomodel.Association> associations)
                        throws javax.xml.registry.JAXRException
Parameters:
associations - Associations to be removed.
Throws:
javax.xml.registry.JAXRException - JAXRException if a JAXR error occurs
See Also:
RegistryObject.removeAssociations(Collection)

addClassifications

void addClassifications(java.util.Collection<javax.xml.registry.infomodel.Classification> classifications)
                        throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.addClassifications(Collection)

getClassifications

java.util.Collection<javax.xml.registry.infomodel.Classification> getClassifications()
                                                                                     throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.getClassifications()

removeClassifications

void removeClassifications(java.util.Collection<javax.xml.registry.infomodel.Classification> classifications)
                           throws javax.xml.registry.JAXRException
Parameters:
classifications - Classifications to be removed.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.removeClassifications(Collection)

addExternalLinks

void addExternalLinks(java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externalLinks)
                      throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.addExternalLinks(Collection)

getExternalLinks

java.util.Collection<javax.xml.registry.infomodel.ExternalLink> getExternalLinks()
                                                                                 throws javax.xml.registry.JAXRException
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.getExternalLinks()

removeExternalLinks

void removeExternalLinks(java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externalLinks)
                         throws javax.xml.registry.JAXRException
Parameters:
externalLinks - ExternalLinks to be removed.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
RegistryObject.removeExternalLinks(Collection)

addSlots

void addSlots(java.util.Collection<javax.xml.registry.infomodel.Slot> slots)
Parameters:
slots - To be added.
See Also:
ExtensibleObject.addSlots(Collection)

removeSlots

void removeSlots(java.util.Collection<java.lang.String> slotNames)
Parameters:
slotNames - Collection of String Slot names to be removed.
See Also:
ExtensibleObject.removeSlots(Collection)

getSlots

java.util.Collection<javax.xml.registry.infomodel.Slot> getSlots()
                                                                 throws javax.xml.registry.JAXRException
Returns:
Collection of Slot instances this instance is having.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
See Also:
ExtensibleObject.getSlots()

preSave

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> preSave()
                                                                          throws javax.xml.registry.JAXRException,
                                                                                 com.softwareag.security.jaas.principals.SagGeneralSecurityException
This method performs save without actually persisting the data. It is up to the client to save the returned collection of modified registry objects, which will store all changes to DB. This is useful ,e.g., to persists updates within single JAXR transaction.

Returns:
Collection of RegistryObject's to be saved.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - is a SIN error occurs

preDelete

java.util.Collection<javax.xml.registry.infomodel.Key> preDelete()
                                                                 throws javax.xml.registry.JAXRException,
                                                                        com.softwareag.security.jaas.principals.SagGeneralSecurityException
This method performs delete without actually persisting the data. It is up to the client to delete the returned collection of registry object keys, which will store all changes to DB. This is useful ,e.g., to persists deletes within single JAXR transaction.

Returns:
Collection of Key's of registry objects to be deleted.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - is a SIN error occurs