arlut.csd.ganymede
Interface SchemaConstants

All Known Implementing Classes:

adminPersonaCustom, eventCustom, objectEventCustom, ownerCustom, permCustom, taskCustom

public interface SchemaConstants

This file defines known constants for pre-defined Schema object types, fields, and certain pre-defined objects that the server depends on for administering default permissions.

Fixed object types used for the server's operations

Object Name	Object Type ID	Purpose
Owner Group	0	An association between a collection of admin personae and the collection of objects they own.
Admin Persona	1	A record of privileges and owner groups that can be associated with a user.
Role	2	A record of permissions by object and field type. Associated with admin personae.
User	3	A person who can log in to Ganymede.
System Event	4	A type of general system event that can be logged and for which mail can be sent to a list of addresses when it occurs.
Task	5	A schedulable work routine.
Object Event	6	A kind of event that can occur in relation to a specific database object, which can be logged and for which mail can be sent to a list of addresses.

Common fields present in all DBObjects

Field Name	Field ID	Field Type	Purpose
OwnerListField	0	InvidDBField	List of owner groups with authority over this object
ExpirationField	1	DateDBField	date that this object will expire
RemovalField	2	DateDBField	date that this object will be removed
NotesField	3	StringDBField	string field for notes for this object
CreationDateField	4	DateDBField	date that this object was created
CreatorField	5	StringDBField	string describing the creator of this object
ModificationDateField	6	DateDBField	date that this object was last modified
ModifierField	7	StringDBField	string describing the administrator who last modified this object
BackLinksField	8	InvidDBField	any miscellaneous pointers pointing to us are kept track of in this field if we don't have an explicit back-link field set

This file contains lots of other constants for fields in the 7 mandatory object types, but I'm tired of typing, so I'm not going to try to document them in the javadoc class header right now.

Field Summary

static short	BackLinksField any miscellaneous pointers pointing to us are kept track of in this field if we don't have an explicit back-link field.
static short	ContainerField
static short	CreationDateField date that this object was created
static short	CreatorField string describing the creator of this object
static short	EventBase
static short	EventDescription fuller description of this event class, suitable for an email body (String field)
static short	EventExternalMail A list of external email addresses to send mail for this event to.
static short	EventMailBoolean if true, events of this type should be mailed (Boolean field)
static short	EventMailOwners if true, the owner groups owning the objects referenced in this event will get a copy of any mail (Boolean field)
static short	EventMailToSelf if true, the admin performing the action will get a copy of any mail (Boolean field)
static short	EventName Short name for this event class, suitable for an email message title (String field)
static short	EventToken single-word token for this event class (String field)
static short	ExpirationField date that this object will expire
static short	FinalBase what's the last base we currently have defined as a mandatory base?
static short	FinalSystemField in case we add more system fields to objects
static short	ModificationDateField date that this object was last modified
static short	ModifierField string describing the administrator who last modified this object
static short	NotesField string field for notes for this object
static short	ObjectEventBase
static short	ObjectEventDescription fuller description of this event class, suitable for an email body (String field)
static short	ObjectEventExternalMail A list of external email addresses to send mail for this event to.
static short	ObjectEventMailOwners if true, the owner groups owning objects affected by this event will get a copy of the mail
static short	ObjectEventMailToSelf if true, the admin performing the action will get a copy of any mail (Boolean field)
static short	ObjectEventName Short name for this event class, suitable for an email message title (String field)
static short	ObjectEventObjectName the name of the object type that this event category applies to
static short	ObjectEventObjectType the short id of the object type that this event category applies to
static short	ObjectEventToken single-word token for this event class (String field)
static short	OwnerBase all objects are owned by objects of type OwnerBase
static short	OwnerCcAdmins If true, all mail sent in care of this owner group will be distributed to all admins on the list automatically
static short	OwnerExternalMail what external email addresses should be notified if objects owned change?
static short	OwnerListField list of owner groups with authority over this object
static short	OwnerMembersField what admin:role entities have privileges in this OwnerBase?
static short	OwnerNameField name of this owner set
static short	OwnerObjectsOwned what objects does this owner set own?
static short	OwnerSupergash the following is a fixed object id's
static short	PersonaAdminConsole boolean, does this role have access to the admin console?
static short	PersonaAdminPower boolean, does this role have *full* access to the admin console?
static short	PersonaAssocUser if associated with a user, here's the reference.
static short	PersonaBase an administrator privilege record
static short	PersonaGroupsField list of owner groups that this admin is a member of
static short	PersonaLabelField string, a hidden label field.
static short	PersonaMailAddr string, the mail address for this administrator, if not implicitly extracted from their user name.
static short	PersonaMonitorObj Object number for a pre-defined object used by the server
static short	PersonaNameField what is this descriptive tag for this persona, not including the user name?
static short	PersonaPasswordField password for this admin account
static short	PersonaPrivs vector of permission invids for this admin account
static short	PersonaSupergashObj Object number for a pre-defined object used by the server
static short	RemovalField date that this object will be removed.
static short	RoleBase this base contains a set of permission bits constraining the admin personae's power
static short	RoleDefaultMatrix permissions applying to all objects not owned by the relevant personae
static short	RoleDefaultObj Object number for a pre-defined object used by the server
static short	RoleDelegatable can this role be passed on to admins created by admins owning this role?
static short	RoleMatrix permissions applying to objects owned by admin personae
static short	RoleName The name of this Role (String)
static short	RolePersonae what admin personae are using this role?
static short	TaskBase Records of task classes we want to attach to the server
static short	TaskClass what is the fully qualified classname for this builder task?
static short	TaskName name of this task (i.e., DNSBuilder, NISBuilder)
static short	TaskOptionStrings string: vector of option strings that can be interpreted by a given builder task
static short	TaskPeriodAnchor date: anchor point used to determine time of day, week, etc.
static short	TaskPeriodCount numeric: how many period units between task execution?
static short	TaskPeriodUnit string: what is the inteval unit for periodic execution
static short	TaskRunOnCommit boolean: should this task be scheduled for execution when a transaction is committed
static short	TaskRunPeriodically boolean: should this task be scheduled for execution at regular intevals?
static short	UserAdminPersonae pointer to zero or more associated admin personae
static short	UserBase
static short	UserPassword password
static short	UserUserName username string

Field Detail

OwnerListField

public static final short OwnerListField

list of owner groups with authority over this object

ExpirationField

public static final short ExpirationField

date that this object will expire

RemovalField

public static final short RemovalField

date that this object will be removed.

NotesField

public static final short NotesField

string field for notes for this object

CreationDateField

public static final short CreationDateField

date that this object was created

CreatorField

public static final short CreatorField

string describing the creator of this object

ModificationDateField

public static final short ModificationDateField

date that this object was last modified

ModifierField

public static final short ModifierField

string describing the administrator who last modified this object

BackLinksField

public static final short BackLinksField

any miscellaneous pointers pointing to us are kept track of in this field if we don't have an explicit back-link field.

This field is DEPRECATED, and should only be encountered in ganymede.db files from old versions of the Ganymede server.

FinalSystemField

public static final short FinalSystemField

in case we add more system fields to objects

ContainerField

public static final short ContainerField

OwnerBase

public static final short OwnerBase

all objects are owned by objects of type OwnerBase

OwnerNameField

public static final short OwnerNameField

name of this owner set

OwnerMembersField

public static final short OwnerMembersField

what admin:role entities have privileges in this OwnerBase?

OwnerObjectsOwned

public static final short OwnerObjectsOwned

what objects does this owner set own?

OwnerCcAdmins

public static final short OwnerCcAdmins

If true, all mail sent in care of this owner group will be distributed to all admins on the list automatically

OwnerExternalMail

public static final short OwnerExternalMail

what external email addresses should be notified if objects owned change?

OwnerSupergash

public static final short OwnerSupergash

the following is a fixed object id's

PersonaBase

public static final short PersonaBase

an administrator privilege record

PersonaNameField

public static final short PersonaNameField

what is this descriptive tag for this persona, not including the user name?

PersonaPasswordField

public static final short PersonaPasswordField

password for this admin account

PersonaGroupsField

public static final short PersonaGroupsField

list of owner groups that this admin is a member of

PersonaAssocUser

public static final short PersonaAssocUser

if associated with a user, here's the reference.

PersonaPrivs

public static final short PersonaPrivs

vector of permission invids for this admin account

PersonaAdminConsole

public static final short PersonaAdminConsole

boolean, does this role have access to the admin console?

PersonaAdminPower

public static final short PersonaAdminPower

boolean, does this role have *full* access to the admin console?

PersonaMailAddr

public static final short PersonaMailAddr

string, the mail address for this administrator, if not implicitly extracted from their user name.

PersonaLabelField

public static final short PersonaLabelField

string, a hidden label field. Not usually directly editable, derived from PersonaNameField and PersonaAssocUser.

PersonaSupergashObj

public static final short PersonaSupergashObj

Object number for a pre-defined object used by the server

PersonaMonitorObj

public static final short PersonaMonitorObj

Object number for a pre-defined object used by the server

RoleBase

public static final short RoleBase

this base contains a set of permission bits constraining the admin personae's power

RoleName

public static final short RoleName

The name of this Role (String)

RoleMatrix

public static final short RoleMatrix

permissions applying to objects owned by admin personae

RolePersonae

public static final short RolePersonae

what admin personae are using this role?

RoleDefaultMatrix

public static final short RoleDefaultMatrix

permissions applying to all objects not owned by the relevant personae

RoleDelegatable

public static final short RoleDelegatable

can this role be passed on to admins created by admins owning this role?

RoleDefaultObj

public static final short RoleDefaultObj

Object number for a pre-defined object used by the server

UserBase

public static final short UserBase

UserUserName

public static final short UserUserName

username string

UserPassword

public static final short UserPassword

password

UserAdminPersonae

public static final short UserAdminPersonae

pointer to zero or more associated admin personae

EventBase

public static final short EventBase

EventToken

public static final short EventToken

single-word token for this event class (String field)

EventName

public static final short EventName

Short name for this event class, suitable for an email message title (String field)

EventDescription

public static final short EventDescription

fuller description of this event class, suitable for an email body (String field)

EventMailBoolean

public static final short EventMailBoolean

if true, events of this type should be mailed (Boolean field)

EventMailToSelf

public static final short EventMailToSelf

if true, the admin performing the action will get a copy of any mail (Boolean field)

EventMailOwners

public static final short EventMailOwners

if true, the owner groups owning the objects referenced in this event will get a copy of any mail (Boolean field)

EventExternalMail

public static final short EventExternalMail

A list of external email addresses to send mail for this event to. That is, addresses in raw string form, rather than as an invid reference to a user or email list recorded in Ganymede. (String field)

ObjectEventBase

public static final short ObjectEventBase

ObjectEventToken

public static final short ObjectEventToken

single-word token for this event class (String field)

ObjectEventName

public static final short ObjectEventName

Short name for this event class, suitable for an email message title (String field)

ObjectEventDescription

public static final short ObjectEventDescription

fuller description of this event class, suitable for an email body (String field)

ObjectEventMailToSelf

public static final short ObjectEventMailToSelf

if true, the admin performing the action will get a copy of any mail (Boolean field)

ObjectEventObjectName

public static final short ObjectEventObjectName

the name of the object type that this event category applies to

ObjectEventMailOwners

public static final short ObjectEventMailOwners

if true, the owner groups owning objects affected by this event will get a copy of the mail

ObjectEventObjectType

public static final short ObjectEventObjectType

the short id of the object type that this event category applies to

ObjectEventExternalMail

public static final short ObjectEventExternalMail

A list of external email addresses to send mail for this event to. That is, addresses in raw string form, rather than as an invid reference to a user or email list recorded in Ganymede. (String field)

TaskBase

public static final short TaskBase

Records of task classes we want to attach to the server

TaskName

public static final short TaskName

name of this task (i.e., DNSBuilder, NISBuilder)

TaskClass

public static final short TaskClass

what is the fully qualified classname for this builder task?

TaskRunOnCommit

public static final short TaskRunOnCommit

boolean: should this task be scheduled for execution when a transaction is committed

TaskRunPeriodically

public static final short TaskRunPeriodically

boolean: should this task be scheduled for execution at regular intevals?

TaskPeriodUnit

public static final short TaskPeriodUnit

string: what is the inteval unit for periodic execution

TaskPeriodCount

public static final short TaskPeriodCount

numeric: how many period units between task execution?

TaskPeriodAnchor

public static final short TaskPeriodAnchor

date: anchor point used to determine time of day, week, etc.

TaskOptionStrings

public static final short TaskOptionStrings

string: vector of option strings that can be interpreted by a given builder task

FinalBase

public static final short FinalBase

what's the last base we currently have defined as a mandatory base?