com.centrasite.resourceaccess.resources
Interface CentraSitePermission

All Superinterfaces:
ResourceAccessType

public interface CentraSitePermission
extends ResourceAccessType

Represents a CentraSite Permission.


Method Summary
 boolean addImpliedByPermission(CentraSitePermission permission)
          The method adds an additional entry to the collection of permissions which imply this permission.
 boolean addImpliedPermission(CentraSitePermission permission)
          The method adds an additional entry to the collection of permissions implied by this permission.
 boolean addImpliesPermission(CentraSitePermission impliesPermission)
          The method adds an additional entry to the collection of permissions which this permission implies.
 java.util.Collection<CentraSitePermission> getImpliedPermissions()
          Returns a collection of all directly or indirectly implied permissions by this permission.
 javax.xml.registry.infomodel.Organization getOrganization()
          Get the organization that this permission is applicable to.
 CentraSitePermission getSystemLevelPermission()
          Get the system level permission corresponding to this non-system level permission
 boolean implies(CentraSitePermission permission)
          Checks if specified permission is implied directly or indirectly by this permission.
 boolean isInternal()
          Checks if this permission is internal.
 boolean isSystemLevel()
          Check if this is a system level permission.
 void save()
          Persist the permission.
 void setImpliedByPermissions(java.util.Collection<CentraSitePermission> permissions)
          Replaces all previous permissions which imply this permission with the specified permissions.
 void setImpliedPermissions(java.util.Collection<CentraSitePermission> permissions)
          Replaces all previously implied permissions from this permission with the specified permissions.
 void setImpliesPermissions(java.util.Collection<CentraSitePermission> impliesPermissions)
          Replaces all permissions which this permission implies with the specified permissions.
 void setOrganization(javax.xml.registry.infomodel.Organization organization)
          Set the organization that this permission is applicable to.
 void setSystemLevelPermission(CentraSitePermission systemLevelPermission)
          Sets the permission this permission is to be a variant of??
 
Methods inherited from interface com.centrasite.resourceaccess.resources.ResourceAccessType
addAssociations, addClassifications, addExternalLinks, addSlots, getAssociations, getClassifications, getDescription, getDisplayName, getExternalLinks, getExternalProperties, getId, getProperties, getSlots, preDelete, preSave, removeAssociations, removeClassifications, removeExternalLinks, removeProperties, removeSlots, setDescription, setDisplayName, setProperties, synchronizeProperties
 

Method Detail

setOrganization

void setOrganization(javax.xml.registry.infomodel.Organization organization)
                     throws javax.xml.registry.JAXRException,
                            com.softwareag.security.jaas.principals.SagGeneralSecurityException
Set the organization that this permission is applicable to.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

getOrganization

javax.xml.registry.infomodel.Organization getOrganization()
                                                          throws javax.xml.registry.JAXRException,
                                                                 com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get the organization that this permission is applicable to.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

save

void save()
          throws javax.xml.registry.JAXRException,
                 com.softwareag.security.jaas.principals.SagGeneralSecurityException
Persist the permission. If saving system level permission, an organization should not be set. If saving organization level permission, an organization must be set as well as system level permission.

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

setSystemLevelPermission

void setSystemLevelPermission(CentraSitePermission systemLevelPermission)
                              throws javax.xml.registry.JAXRException,
                                     com.softwareag.security.jaas.principals.SagGeneralSecurityException
Sets the permission this permission is to be a variant of??

Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

isSystemLevel

boolean isSystemLevel()
                      throws javax.xml.registry.JAXRException,
                             com.softwareag.security.jaas.principals.SagGeneralSecurityException
Check if this is a system level permission.

Returns:
true if this is a system level permission.
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs

addImpliedPermission

boolean addImpliedPermission(CentraSitePermission permission)
                             throws javax.xml.registry.JAXRException
The method adds an additional entry to the collection of permissions implied by this permission.

Parameters:
permission - Permission to be added to the collection of implied
Returns:
true if the collection of implied permissions changed as a result of the call
Throws:
javax.xml.registry.JAXRException - If the collection of implied permissions refuses to add a particular element for any reason other than that it already contains the element.

setImpliedPermissions

void setImpliedPermissions(java.util.Collection<CentraSitePermission> permissions)
                           throws javax.xml.registry.JAXRException
Replaces all previously implied permissions from this permission with the specified permissions.

Parameters:
permissions - Permissions collection to replace currently implied permissions.
Throws:
javax.xml.registry.JAXRException - If the collection of permissions cannot replace the current collection of implied permissions.

getImpliedPermissions

java.util.Collection<CentraSitePermission> getImpliedPermissions()
Returns a collection of all directly or indirectly implied permissions by this permission.

Returns:
Returns a collection of the implied permissions or empty collection if there are no such.

addImpliedByPermission

boolean addImpliedByPermission(CentraSitePermission permission)
                               throws javax.xml.registry.JAXRException
The method adds an additional entry to the collection of permissions which imply this permission.

Parameters:
permission - Permission to be added to the collection.
Returns:
true if the collection changed as a result of the call
Throws:
javax.xml.registry.JAXRException - If the collection refuses to add a particular element for any reason other than that it already contains the element.

setImpliedByPermissions

void setImpliedByPermissions(java.util.Collection<CentraSitePermission> permissions)
Replaces all previous permissions which imply this permission with the specified permissions.

Parameters:
permissions - Permissions collection to replace currently imply permissions.
Throws:
javax.xml.registry.JAXRException - If the collection of permissions cannot replace the current collection of imply permissions.

addImpliesPermission

boolean addImpliesPermission(CentraSitePermission impliesPermission)
                             throws javax.xml.registry.JAXRException
The method adds an additional entry to the collection of permissions which this permission implies.

Parameters:
impliesPermission - Permission to be added to the collection permissions which this permission implies.
Returns:
true if the collection of permissions which this permission implies changed as a result of the call
Throws:
javax.xml.registry.JAXRException - If the collection of permissions which this permission implies refuses to add a particular element for any reason other than that it already contains the element.

setImpliesPermissions

void setImpliesPermissions(java.util.Collection<CentraSitePermission> impliesPermissions)
                           throws javax.xml.registry.JAXRException
Replaces all permissions which this permission implies with the specified permissions.

Parameters:
impliesPermissions - Permissions collection to replace permissions that this permission currently implies.
Throws:
javax.xml.registry.JAXRException - If the collection of permissions. which this permission currently implies, cannot be replaced.

implies

boolean implies(CentraSitePermission permission)
Checks if specified permission is implied directly or indirectly by this permission.

Parameters:
permission - The specific permission to check against.
Returns:
true if the specific permission is implied directly or indirectly by this permission.

isInternal

boolean isInternal()
Checks if this permission is internal.

Returns:
true if this permission is internal.

getSystemLevelPermission

CentraSitePermission getSystemLevelPermission()
                                              throws javax.xml.registry.JAXRException,
                                                     com.softwareag.security.jaas.principals.SagGeneralSecurityException
Get the system level permission corresponding to this non-system level permission

Returns:
the system level permission or the current object if it is a system level permission itself
Throws:
javax.xml.registry.JAXRException - if a JAXR error occurs
com.softwareag.security.jaas.principals.SagGeneralSecurityException - if a security error occurs