org.biomage.AuditAndSecurity
Class Security

java.lang.Object
  |
  +--org.biomage.Common.Extendable
        |
        +--org.biomage.Common.Describable
              |
              +--org.biomage.Common.Identifiable
                    |
                    +--org.biomage.AuditAndSecurity.Security

All Implemented Interfaces:

HasAuditTrail, HasDescriptions, HasOwner, HasPropertySets, HasReadGroups, HasSecurity, HasWriteGroups, java.io.Serializable

public class Security

extends Identifiable

implements java.io.Serializable, HasReadGroups, HasWriteGroups, HasOwner

Permission information for an object as to ownership, write and read permissions.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.biomage.Interface.HasReadGroups

HasReadGroups.ReadGroups_list

Nested classes inherited from class org.biomage.Interface.HasWriteGroups

HasWriteGroups.WriteGroups_list

Nested classes inherited from class org.biomage.Interface.HasAuditTrail

HasAuditTrail.AuditTrail_list

Nested classes inherited from class org.biomage.Interface.HasDescriptions

HasDescriptions.Descriptions_list

Nested classes inherited from class org.biomage.Interface.HasPropertySets

HasPropertySets.PropertySets_list

Field Summary

protected Contact	owner The owner of the security rights.
protected HasReadGroups.ReadGroups_list	readGroups Specifies which security groups have read permission.
protected HasWriteGroups.WriteGroups_list	writeGroups Specifies which security groups have write permission.

Fields inherited from class org.biomage.Common.Describable

auditTrail, descriptions, security

Fields inherited from class org.biomage.Common.Extendable

propertySets

Constructor Summary

Security()
Default constructor.

Security(org.xml.sax.Attributes atts)
Attribute constructor.

Method Summary

void	addToReadGroups(int position, SecurityGroup securityGroup) Method to add SecurityGroup at position to ReadGroups_list
void	addToReadGroups(SecurityGroup securityGroup) Method to add SecurityGroup to ReadGroups_list
void	addToWriteGroups(int position, SecurityGroup securityGroup) Method to add SecurityGroup at position to WriteGroups_list
void	addToWriteGroups(SecurityGroup securityGroup) Method to add SecurityGroup to WriteGroups_list
SecurityGroup	getFromReadGroups(int position) Method to get SecurityGroup from ReadGroups_list
SecurityGroup	getFromWriteGroups(int position) Method to get SecurityGroup from WriteGroups_list
Contact	getOwner() Get method for owner
HasReadGroups.ReadGroups_list	getReadGroups() Get method for readGroups
HasWriteGroups.WriteGroups_list	getWriteGroups() Get method for writeGroups
void	removeElementAtFromReadGroups(int position) Method to remove by position from ReadGroups_list
void	removeElementAtFromWriteGroups(int position) Method to remove by position from WriteGroups_list
void	removeFromReadGroups(SecurityGroup securityGroup) Method to remove first SecurityGroup from ReadGroups_list
void	removeFromWriteGroups(SecurityGroup securityGroup) Method to remove first SecurityGroup from WriteGroups_list
void	setOwner(Contact owner) Set method for owner
void	setReadGroups(HasReadGroups.ReadGroups_list readGroups) Set method for readGroups
void	setWriteGroups(HasWriteGroups.WriteGroups_list writeGroups) Set method for writeGroups
void	writeAssociations(java.io.Writer out) writeAssociations This method is responsible for assembling the association data into XML.
void	writeAttributes(java.io.Writer out) writeAttributes This method is responsible for assembling the attribute data into XML.
void	writeMAGEML(java.io.Writer out) writeMAGEML This method is responsible for assembling the attribute and association data into XML.

Methods inherited from class org.biomage.Common.Identifiable

getIdentifier, getName, setIdentifier, setName

Methods inherited from class org.biomage.Common.Describable

addToAuditTrail, addToAuditTrail, addToDescriptions, addToDescriptions, getAuditTrail, getDescriptions, getFromAuditTrail, getFromDescriptions, getSecurity, removeElementAtFromAuditTrail, removeElementAtFromDescriptions, removeFromAuditTrail, removeFromDescriptions, setAuditTrail, setDescriptions, setSecurity

Methods inherited from class org.biomage.Common.Extendable

addToPropertySets, addToPropertySets, getFromPropertySets, getPropertySets, removeElementAtFromPropertySets, removeFromPropertySets, setPropertySets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

owner

protected Contact owner

The owner of the security rights.

readGroups

protected HasReadGroups.ReadGroups_list readGroups

Specifies which security groups have read permission.

writeGroups

protected HasWriteGroups.WriteGroups_list writeGroups

Specifies which security groups have write permission.

Constructor Detail

Security

public Security()

Default constructor.

Security

public Security(org.xml.sax.Attributes atts)

Attribute constructor. Looks up the attributes in the parameter and casts them from strings appropriately

Method Detail

writeMAGEML

public void writeMAGEML(java.io.Writer out)
                 throws java.io.IOException

writeMAGEML This method is responsible for assembling the attribute and association data into XML. It creates the object tag and then calls the writeAttributes and writeAssociation methods.

Overrides:

writeMAGEML in class Identifiable

java.io.IOException

writeAttributes

public void writeAttributes(java.io.Writer out)
                     throws java.io.IOException

writeAttributes This method is responsible for assembling the attribute data into XML. It calls the super method to write out all attributes of this class and it's ancestors.

Overrides:

writeAttributes in class Identifiable

java.io.IOException

writeAssociations

public void writeAssociations(java.io.Writer out)
                       throws java.io.IOException

writeAssociations This method is responsible for assembling the association data into XML. It calls the super method to write out all associations of this class's ancestors.

Overrides:

writeAssociations in class Identifiable

java.io.IOException

setOwner

public void setOwner(Contact owner)

Set method for owner

Specified by:

setOwner in interface HasOwner

getOwner

public Contact getOwner()

Get method for owner

Specified by:

getOwner in interface HasOwner

Returns:

value of the attribute

setReadGroups

public void setReadGroups(HasReadGroups.ReadGroups_list readGroups)

Set method for readGroups

Specified by:

setReadGroups in interface HasReadGroups

getReadGroups

public HasReadGroups.ReadGroups_list getReadGroups()

Get method for readGroups

Specified by:

getReadGroups in interface HasReadGroups

Returns:

value of the attribute

addToReadGroups

public void addToReadGroups(SecurityGroup securityGroup)

Method to add SecurityGroup to ReadGroups_list

Specified by:

addToReadGroups in interface HasReadGroups

addToReadGroups

public void addToReadGroups(int position,
                            SecurityGroup securityGroup)

Method to add SecurityGroup at position to ReadGroups_list

Specified by:

addToReadGroups in interface HasReadGroups

getFromReadGroups

public SecurityGroup getFromReadGroups(int position)

Method to get SecurityGroup from ReadGroups_list

Specified by:

getFromReadGroups in interface HasReadGroups

removeElementAtFromReadGroups

public void removeElementAtFromReadGroups(int position)

Method to remove by position from ReadGroups_list

Specified by:

removeElementAtFromReadGroups in interface HasReadGroups

removeFromReadGroups

public void removeFromReadGroups(SecurityGroup securityGroup)

Method to remove first SecurityGroup from ReadGroups_list

Specified by:

removeFromReadGroups in interface HasReadGroups

setWriteGroups

public void setWriteGroups(HasWriteGroups.WriteGroups_list writeGroups)

Set method for writeGroups

Specified by:

setWriteGroups in interface HasWriteGroups

getWriteGroups

public HasWriteGroups.WriteGroups_list getWriteGroups()

Get method for writeGroups

Specified by:

getWriteGroups in interface HasWriteGroups

Returns:

value of the attribute

addToWriteGroups

public void addToWriteGroups(SecurityGroup securityGroup)

Method to add SecurityGroup to WriteGroups_list

Specified by:

addToWriteGroups in interface HasWriteGroups

addToWriteGroups

public void addToWriteGroups(int position,
                             SecurityGroup securityGroup)

Method to add SecurityGroup at position to WriteGroups_list

Specified by:

addToWriteGroups in interface HasWriteGroups

getFromWriteGroups

public SecurityGroup getFromWriteGroups(int position)

Method to get SecurityGroup from WriteGroups_list

Specified by:

getFromWriteGroups in interface HasWriteGroups

removeElementAtFromWriteGroups

public void removeElementAtFromWriteGroups(int position)

Method to remove by position from WriteGroups_list

Specified by:

removeElementAtFromWriteGroups in interface HasWriteGroups

removeFromWriteGroups

public void removeFromWriteGroups(SecurityGroup securityGroup)

Method to remove first SecurityGroup from WriteGroups_list

Specified by:

removeFromWriteGroups in interface HasWriteGroups