org.okiproject.serviceimpl.mit.roles
Class RolesFactory

java.lang.Object
  |
  +--org.okiproject.serviceapi.roles.RolesFactory
        |
        +--org.okiproject.serviceimpl.mit.roles.RolesFactory
All Implemented Interfaces:
java.io.Serializable

public class RolesFactory
extends org.okiproject.serviceapi.roles.RolesFactory

Copyright (c) 2001 Massachusetts Institute of Technology

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

$Source: /cvs/oki/org/okiproject/serviceimpl/mit/doc/roles/org/okiproject/serviceimpl/mit/roles/RolesFactory.html,v $

See Also:
Serialized Form

Constructor Summary
RolesFactory()
           
 
Method Summary
 org.okiproject.serviceapi.roles.Authorization createAuthorization(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier, org.okiproject.serviceapi.roles.GrantPrivilege grant, java.lang.Boolean doFunction)
          Creates a new Authorization in the Roles DB for a Person doing a Function with a Qualifier and having Grant rights and ability to doFunction.
 org.okiproject.serviceapi.roles.Authorization createAuthorization(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier, org.okiproject.serviceapi.roles.GrantPrivilege grant, java.lang.Boolean doFunction, java.sql.Timestamp effectiveDate, java.sql.Timestamp expirationDate)
          Creates a new Authorization in the Roles DB for a Person doing a Function with a Qualifier and having Grant rights and ability to doFunction.
 org.okiproject.serviceapi.roles.Function createFunction(java.lang.String name, java.lang.String description, org.okiproject.serviceapi.roles.FunctionCategory functionCategory, org.okiproject.serviceapi.roles.QualifierType qualifierType)
          Creates a new function in the Roles DB.
 org.okiproject.serviceapi.roles.Qualifier createQualifier(org.okiproject.serviceapi.roles.QualifierType qualifierType, java.lang.String qualifierCode, java.lang.String description, org.okiproject.serviceapi.roles.Qualifier parent)
          Creates a new Qualifier in the Roles DB.
static java.lang.String createRolesDate(java.sql.Timestamp timestamp)
           
static java.sql.Timestamp createSqlTimestamp(java.lang.String rolesDate)
           
 void deleteAuthorization(org.okiproject.serviceapi.roles.Authorization authorization)
          Deletes an existing authorization in the Roles DB.
 void deleteFunction(org.okiproject.serviceapi.roles.Function function)
          Deletes an existing function in the Roles DB.
 void deleteQualifier(org.okiproject.serviceapi.roles.Qualifier qualifier)
          Deletes an existing qualifier in the Roles DB.
 org.okiproject.serviceapi.roles.Authorizations getAuthsForDoingFWithQ(org.okiproject.serviceapi.roles.FunctionCategory functionCategory, org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.Boolean isActiveNow)
          Given a FunctionCategory and a Qualifier returns an enumeration of all Authorizations that would allow people to do Functions in the FunctionCategory with Qualifier.
 org.okiproject.serviceapi.roles.Authorizations getAuthsForDoingFWithQ(org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.Boolean isActiveNow)
          Given a Function and a Qualifier returns an enumeration of all Authorizations that would allow people to do the Function with Qualifier.
 org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Given a Person returns an enumeration of Authorizations matching the Person where Function and Qualifier are not considered.
 org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.Function function, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Given a Person and a Function returns an enumeration of Authorizations matching the Person and the Function where Qualifier is not considered.
 org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.FunctionCategory functionCategory, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Given a Person and a FunctionCategory returns an enumeration of Authorizations matching the Person and any Function in the given FunctionCategory where Qualifier is not considered.
 org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.FunctionCategory functionCategory, org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean expandQualifiers)
          Given at a Person, a FunctionCategory, and a Qualifier returns an enumeration of matching authorizations.
 org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.Boolean isActiveNow, java.lang.Boolean expandFunctions, java.lang.Boolean qualifiersOptions)
          Given at a Person, a Function, and a Qualifier returns an enumeration of matching authorizations.
 org.okiproject.serviceapi.sql.Connection getConnection()
           
 org.okiproject.serviceapi.roles.Field[] getCurrentAuthorizationFields()
           
 org.okiproject.serviceapi.roles.Field[] getCurrentFunctionFields()
           
 org.okiproject.serviceapi.roles.Field[] getCurrentPersonFields()
           
 org.okiproject.serviceapi.roles.Field[] getCurrentQualifierFields()
           
 org.okiproject.serviceapi.common.Person getForUser()
           
 org.okiproject.serviceapi.roles.Functions getFunctionsInCategory(org.okiproject.serviceapi.roles.FunctionCategory functionCategory)
          Given a FunctionCategory returns an enumeration of Functions from the Roles DB
 org.okiproject.serviceapi.roles.Qualifiers getQualifierChildren(org.okiproject.serviceapi.roles.Qualifier qualifier)
          Given an existing qualifier returns a list of its child qualifiers.
 org.okiproject.serviceapi.roles.Qualifier getRootQualifier(org.okiproject.serviceapi.roles.QualifierType qualifierType)
          Given a Qualifier Type returns the qualifier that is the root of the tree of qualifiers of this type.
 org.okiproject.serviceapi.sql.SqlFactory getSqlFactory()
           
 org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.Function function, java.lang.Boolean isActiveNow)
          Given a Function returns an enumeration of all people at least one Authorization for the Function where the Qualifier is not considered.
 org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.FunctionCategory functionCategory, java.lang.Boolean isActiveNow)
          Given a FunctionCategory returns an enumeration of all people with at least one Authorization for at least one Function in this FunctionCategory where the Qualifier is not considered.
 org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.FunctionCategory functionCategory, org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.Boolean isActiveNow)
          Given a FunctionCategory and a Qualifier returns an enumeration of all people with at least one Authorization for at least one Function in this FunctionCategory for the Qualifier.
 org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.Boolean isActiveNow)
          Given a Function and a Qualifier returns an enumeration of all people allowed to do the Function with the Qualifier.
 java.lang.Boolean isAuthorized(org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier)
          Given a Person, Function, and Qualifier returns true if the Person is authorized to perform the given Function with the given Qualifier.
 java.lang.Boolean isFunctionCategoryFoundInRoles(org.okiproject.serviceapi.roles.FunctionCategory functionCategory)
          Determines if this FunctionCategory has a matching FunctionCategory in the Roles DB.
 java.lang.Boolean isFunctionFoundInRoles(org.okiproject.serviceapi.roles.Function function)
          Determines if this Function has a matching Function in the Roles DB.
 java.lang.Boolean isPersonFoundInRoles(org.okiproject.serviceapi.common.Person person)
          Determines if this Person has a matching Person in the Roles DB.
 java.lang.Boolean isQualifierFoundInRoles(org.okiproject.serviceapi.roles.Qualifier qualifier)
          Determines if this Qualifier has a matching Qualifier in the Roles DB.
 java.lang.Boolean isQualifierTypeFoundInRoles(org.okiproject.serviceapi.roles.QualifierType qualifierType)
          Determines if this QualifierType has a matching QualifierType in the Roles DB.
 org.okiproject.serviceapi.roles.Function newFunction(org.okiproject.serviceapi.roles.FunctionCategory functionCategory, java.lang.String name)
           
 org.okiproject.serviceapi.roles.Function newFunction(java.lang.Object id)
           
 org.okiproject.serviceapi.roles.Function newFunction(java.lang.Object id, org.okiproject.serviceapi.roles.FunctionCategory functionCategory, java.lang.String name)
           
 org.okiproject.serviceapi.roles.Function newFunction(java.lang.String functionCategoryString, java.lang.String name)
           
 org.okiproject.serviceapi.roles.FunctionCategory newFunctionCategory(java.lang.String functionCategoryString)
          Returns a new instance of FunctionCategory.
 org.okiproject.serviceapi.roles.GrantPrivilege newGrantPrivilege(java.lang.String grantPrivilege)
          The instance created is local to the application.
 org.okiproject.serviceapi.common.Person newPerson(java.lang.Object key)
          Returns a new instance of Person.
 org.okiproject.serviceapi.roles.Qualifier newQualifier(java.lang.Object id)
           
 org.okiproject.serviceapi.roles.Qualifier newQualifier(org.okiproject.serviceapi.roles.QualifierType qualifierType, java.lang.String qualifierCode)
          Returns a new instance of org.okiproject.serviceapi.roles.Qualifier.
 org.okiproject.serviceapi.roles.Qualifier newQualifier(java.lang.String qualifierType, java.lang.String qualifierCode)
          Returns a new instance of org.okiproject.serviceapi.roles.Qualifier.
 org.okiproject.serviceapi.roles.QualifierType newQualifierType(java.lang.String qualifierType)
          Returns a new instance of org.okiproject.serviceapi.roles.QualifierType.
 void refreshFunction(org.okiproject.serviceapi.roles.Function function)
          Refreshs Function properties from a changing Roles DB.
 void refreshFunctionCategory(org.okiproject.serviceapi.roles.FunctionCategory functionCategory)
          Refreshs FunctionCategory properties from a changing Roles DB.
 void refreshPerson(org.okiproject.serviceapi.common.Person person)
          Refresh properties from a changing Roles DB.
 void refreshQualifier(org.okiproject.serviceapi.roles.Qualifier qualifier)
          Refreshes properties from a changing Roles DB.
 void refreshQualifierType(org.okiproject.serviceapi.roles.QualifierType qualifierType)
          Refreshes QualifierType properties from a changing Roles DB.
 void updateAuthorization(org.okiproject.serviceapi.roles.Authorization authorization, org.okiproject.serviceapi.common.Person person, org.okiproject.serviceapi.roles.Function function, org.okiproject.serviceapi.roles.Qualifier qualifier, org.okiproject.serviceapi.roles.GrantPrivilege grant, java.lang.Boolean doFunction, java.sql.Timestamp effectiveDate, java.sql.Timestamp expirationDate)
          Updates one or more fields in an existing authorization in the Roles DB.
 void updateFunction(org.okiproject.serviceapi.roles.Function function, java.lang.String newName, java.lang.String newDescription, org.okiproject.serviceapi.roles.FunctionCategory newFunctionCategory, org.okiproject.serviceapi.roles.QualifierType newQualifierType)
          Updates one or more fields in an existing function in the Roles DB.
 void updateQualifier(org.okiproject.serviceapi.roles.Qualifier qualifier, java.lang.String newQualifierCode, java.lang.String newDescription)
          Updates one or more fields in an existing qualifier in the Roles DB.
 
Methods inherited from class org.okiproject.serviceapi.roles.RolesFactory
createFunctionCategory, createQualifierType, deleteFunctionCategory, deleteQualifierType, getAuthsGeneralForm, getAuthsSimpleForm, getAuthsSimpleForm, getAuthsSimpleForm, getAuthsSimpleForm, getAuthsSimpleForm, getCompleteAuthorizationFields, getCompleteFunctionFields, getCompletePersonFields, getCompleteQualifierFields, getDatabaseSymbolicName, getDatabaseSymbolicNames, getDefaultAuthorizationFields, getDefaultFunctionFields, getDefaultPersonFields, getDefaultQualifierFields, getDefaultRolesFactory, getDefaultRolesFactory, getFunctionCategories, getFunctionsGeneralForm, getMinimumAuthorizationFields, getMinimumFunctionFields, getMinimumPersonFields, getMinimumQualifierFields, getPeopleGeneralForm, getProperties, getQualifiersGeneralForm, getQualifierTypes, getServiceName, getWhoCanDo, isAuthorized, isAuthorized, setCurrentAuthorizationFields, setCurrentFunctionFields, setCurrentPersonFields, setCurrentQualifierFields, setDatabaseSymbolicName, setProperties, setServiceName, updateFunctionCategory, updateQualifierType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RolesFactory

public RolesFactory()
Method Detail

getSqlFactory

public org.okiproject.serviceapi.sql.SqlFactory getSqlFactory()

getConnection

public org.okiproject.serviceapi.sql.Connection getConnection()
                                                       throws java.lang.Exception

getForUser

public org.okiproject.serviceapi.common.Person getForUser()

createRolesDate

public static java.lang.String createRolesDate(java.sql.Timestamp timestamp)
                                        throws java.lang.Exception

createSqlTimestamp

public static java.sql.Timestamp createSqlTimestamp(java.lang.String rolesDate)
                                             throws java.lang.Exception

createAuthorization

public org.okiproject.serviceapi.roles.Authorization createAuthorization(org.okiproject.serviceapi.common.Person person,
                                                                         org.okiproject.serviceapi.roles.Function function,
                                                                         org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                                         org.okiproject.serviceapi.roles.GrantPrivilege grant,
                                                                         java.lang.Boolean doFunction,
                                                                         java.sql.Timestamp effectiveDate,
                                                                         java.sql.Timestamp expirationDate)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Creates a new Authorization in the Roles DB for a Person doing a Function with a Qualifier and having Grant rights and ability to doFunction.
Overrides:
createAuthorization in class org.okiproject.serviceapi.roles.RolesFactory

createAuthorization

public org.okiproject.serviceapi.roles.Authorization createAuthorization(org.okiproject.serviceapi.common.Person person,
                                                                         org.okiproject.serviceapi.roles.Function function,
                                                                         org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                                         org.okiproject.serviceapi.roles.GrantPrivilege grant,
                                                                         java.lang.Boolean doFunction)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Creates a new Authorization in the Roles DB for a Person doing a Function with a Qualifier and having Grant rights and ability to doFunction. Uses current date/time as the effectiveDate and doesn't set an exiration date.
Overrides:
createAuthorization in class org.okiproject.serviceapi.roles.RolesFactory

deleteAuthorization

public void deleteAuthorization(org.okiproject.serviceapi.roles.Authorization authorization)
                         throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Deletes an existing authorization in the Roles DB.
Overrides:
deleteAuthorization in class org.okiproject.serviceapi.roles.RolesFactory

updateAuthorization

public void updateAuthorization(org.okiproject.serviceapi.roles.Authorization authorization,
                                org.okiproject.serviceapi.common.Person person,
                                org.okiproject.serviceapi.roles.Function function,
                                org.okiproject.serviceapi.roles.Qualifier qualifier,
                                org.okiproject.serviceapi.roles.GrantPrivilege grant,
                                java.lang.Boolean doFunction,
                                java.sql.Timestamp effectiveDate,
                                java.sql.Timestamp expirationDate)
                         throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Updates one or more fields in an existing authorization in the Roles DB.
Overrides:
updateAuthorization in class org.okiproject.serviceapi.roles.RolesFactory

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.Function function,
                                                           org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Function and a Qualifier returns an enumeration of all people allowed to do the Function with the Qualifier.
Overrides:
getWhoCanDo in class org.okiproject.serviceapi.roles.RolesFactory

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.Function function,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Function returns an enumeration of all people at least one Authorization for the Function where the Qualifier is not considered.
Overrides:
getWhoCanDo in class org.okiproject.serviceapi.roles.RolesFactory

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a FunctionCategory returns an enumeration of all people with at least one Authorization for at least one Function in this FunctionCategory where the Qualifier is not considered.
Overrides:
getWhoCanDo in class org.okiproject.serviceapi.roles.RolesFactory

getWhoCanDo

public org.okiproject.serviceapi.common.Agents getWhoCanDo(org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                           org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                           java.lang.Boolean isActiveNow)
                                                    throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a FunctionCategory and a Qualifier returns an enumeration of all people with at least one Authorization for at least one Function in this FunctionCategory for the Qualifier.
Overrides:
getWhoCanDo in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsForDoingFWithQ

public org.okiproject.serviceapi.roles.Authorizations getAuthsForDoingFWithQ(org.okiproject.serviceapi.roles.Function function,
                                                                             org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                                             java.lang.Boolean isActiveNow)
                                                                      throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Function and a Qualifier returns an enumeration of all Authorizations that would allow people to do the Function with Qualifier. This method differs from the simple form of getAuthsSimpleForm in that this method looks for any Authorization that permits doing the Function with the Qualifier even if the Authorization's Qualifier happens to be a parent of this Qualifier argument.
Overrides:
getAuthsForDoingFWithQ in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsForDoingFWithQ

public org.okiproject.serviceapi.roles.Authorizations getAuthsForDoingFWithQ(org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                                             org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                                             java.lang.Boolean isActiveNow)
                                                                      throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a FunctionCategory and a Qualifier returns an enumeration of all Authorizations that would allow people to do Functions in the FunctionCategory with Qualifier. This method differs from getAuthsSimpleForm in that this method looks for any Authorization that permits doing the Function with the Qualifier even if the Authorization's Qualifier happens to be a parent of the Qualifier argument.
Overrides:
getAuthsForDoingFWithQ in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsSimpleForm

public org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person,
                                                                         org.okiproject.serviceapi.roles.Function function,
                                                                         org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                                         java.lang.Boolean isActiveNow,
                                                                         java.lang.Boolean expandFunctions,
                                                                         java.lang.Boolean qualifiersOptions)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given at a Person, a Function, and a Qualifier returns an enumeration of matching authorizations.
Overrides:
getAuthsSimpleForm in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsSimpleForm

public org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person,
                                                                         org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                                         org.okiproject.serviceapi.roles.Qualifier qualifier,
                                                                         java.lang.Boolean isActiveNow,
                                                                         java.lang.Boolean expandFunctions,
                                                                         java.lang.Boolean expandQualifiers)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given at a Person, a FunctionCategory, and a Qualifier returns an enumeration of matching authorizations. The authorizations must be for Functions within the given FunctionCategory.
Overrides:
getAuthsSimpleForm in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsSimpleForm

public org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person,
                                                                         org.okiproject.serviceapi.roles.Function function,
                                                                         java.lang.Boolean isActiveNow,
                                                                         java.lang.Boolean expandFunctions,
                                                                         java.lang.Boolean expandQualifiers)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Person and a Function returns an enumeration of Authorizations matching the Person and the Function where Qualifier is not considered.
Overrides:
getAuthsSimpleForm in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsSimpleForm

public org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person,
                                                                         org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                                         java.lang.Boolean isActiveNow,
                                                                         java.lang.Boolean expandFunctions,
                                                                         java.lang.Boolean expandQualifiers)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Person and a FunctionCategory returns an enumeration of Authorizations matching the Person and any Function in the given FunctionCategory where Qualifier is not considered.
Overrides:
getAuthsSimpleForm in class org.okiproject.serviceapi.roles.RolesFactory

getAuthsSimpleForm

public org.okiproject.serviceapi.roles.Authorizations getAuthsSimpleForm(org.okiproject.serviceapi.common.Person person,
                                                                         java.lang.Boolean isActiveNow,
                                                                         java.lang.Boolean expandFunctions,
                                                                         java.lang.Boolean expandQualifiers)
                                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Person returns an enumeration of Authorizations matching the Person where Function and Qualifier are not considered.
Overrides:
getAuthsSimpleForm in class org.okiproject.serviceapi.roles.RolesFactory

isAuthorized

public java.lang.Boolean isAuthorized(org.okiproject.serviceapi.common.Person person,
                                      org.okiproject.serviceapi.roles.Function function,
                                      org.okiproject.serviceapi.roles.Qualifier qualifier)
                               throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Person, Function, and Qualifier returns true if the Person is authorized to perform the given Function with the given Qualifier.
Overrides:
isAuthorized in class org.okiproject.serviceapi.roles.RolesFactory

getCurrentAuthorizationFields

public org.okiproject.serviceapi.roles.Field[] getCurrentAuthorizationFields()
                                                                      throws java.lang.Exception
Overrides:
getCurrentAuthorizationFields in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
the current list of Authorization fields.

getCurrentPersonFields

public org.okiproject.serviceapi.roles.Field[] getCurrentPersonFields()
                                                               throws java.lang.Exception
Overrides:
getCurrentPersonFields in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
the current list of Person fields.

newPerson

public org.okiproject.serviceapi.common.Person newPerson(java.lang.Object key)
                                                  throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns a new instance of Person. The instance is local to the application. The person may or may not exist in the Roles DB. (The key for MIT is KerberosName. Other implementations may use other ways to uniquely identify people.)
Overrides:
newPerson in class org.okiproject.serviceapi.roles.RolesFactory

isPersonFoundInRoles

public java.lang.Boolean isPersonFoundInRoles(org.okiproject.serviceapi.common.Person person)
                                       throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Determines if this Person has a matching Person in the Roles DB.
Overrides:
isPersonFoundInRoles in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
true indicates Person is in the Roles DB as are its properties.

refreshPerson

public void refreshPerson(org.okiproject.serviceapi.common.Person person)
                   throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Refresh properties from a changing Roles DB.
Overrides:
refreshPerson in class org.okiproject.serviceapi.roles.RolesFactory

getCurrentFunctionFields

public org.okiproject.serviceapi.roles.Field[] getCurrentFunctionFields()
                                                                 throws java.lang.Exception
Overrides:
getCurrentFunctionFields in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
the current list of Function fields.

newFunction

public org.okiproject.serviceapi.roles.Function newFunction(org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                            java.lang.String name)
                                                     throws java.lang.Exception
Overrides:
newFunction in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
new instance of Function. The instance is local to the application. It may or may not exist in Roles.

newFunction

public org.okiproject.serviceapi.roles.Function newFunction(java.lang.String functionCategoryString,
                                                            java.lang.String name)
                                                     throws java.lang.Exception
Overrides:
newFunction in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
new instance of Function. The instance is local to the application. It may or may not exist in the Roles DB. This method will create an instance of org.okiproject.serviceapi.roles.Function from the string functionCategory.

newFunction

public org.okiproject.serviceapi.roles.Function newFunction(java.lang.Object id)
                                                     throws java.lang.Exception

newFunction

public org.okiproject.serviceapi.roles.Function newFunction(java.lang.Object id,
                                                            org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                            java.lang.String name)
                                                     throws java.lang.Exception

newFunctionCategory

public org.okiproject.serviceapi.roles.FunctionCategory newFunctionCategory(java.lang.String functionCategoryString)
                                                                     throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns a new instance of FunctionCategory. The instance is local to the application. It may or may not exist in the Roles DB.
Overrides:
newFunctionCategory in class org.okiproject.serviceapi.roles.RolesFactory

createFunction

public org.okiproject.serviceapi.roles.Function createFunction(java.lang.String name,
                                                               java.lang.String description,
                                                               org.okiproject.serviceapi.roles.FunctionCategory functionCategory,
                                                               org.okiproject.serviceapi.roles.QualifierType qualifierType)
                                                        throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Creates a new function in the Roles DB.
Overrides:
createFunction in class org.okiproject.serviceapi.roles.RolesFactory

deleteFunction

public void deleteFunction(org.okiproject.serviceapi.roles.Function function)
                    throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Deletes an existing function in the Roles DB.
Overrides:
deleteFunction in class org.okiproject.serviceapi.roles.RolesFactory

isFunctionFoundInRoles

public java.lang.Boolean isFunctionFoundInRoles(org.okiproject.serviceapi.roles.Function function)
                                         throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Determines if this Function has a matching Function in the Roles DB.
Overrides:
isFunctionFoundInRoles in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
true indicates Function is in the Roles DB as are its properties.

refreshFunction

public void refreshFunction(org.okiproject.serviceapi.roles.Function function)
                     throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Refreshs Function properties from a changing Roles DB.
Overrides:
refreshFunction in class org.okiproject.serviceapi.roles.RolesFactory

updateFunction

public void updateFunction(org.okiproject.serviceapi.roles.Function function,
                           java.lang.String newName,
                           java.lang.String newDescription,
                           org.okiproject.serviceapi.roles.FunctionCategory newFunctionCategory,
                           org.okiproject.serviceapi.roles.QualifierType newQualifierType)
                    throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Updates one or more fields in an existing function in the Roles DB.
Overrides:
updateFunction in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
See Also:
FunctionCategory, QualifierType

isFunctionCategoryFoundInRoles

public java.lang.Boolean isFunctionCategoryFoundInRoles(org.okiproject.serviceapi.roles.FunctionCategory functionCategory)
                                                 throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Determines if this FunctionCategory has a matching FunctionCategory in the Roles DB.
Overrides:
isFunctionCategoryFoundInRoles in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
true indicates FunctionCategory is in the Roles DB as are its properties.

refreshFunctionCategory

public void refreshFunctionCategory(org.okiproject.serviceapi.roles.FunctionCategory functionCategory)
                             throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Refreshs FunctionCategory properties from a changing Roles DB.
Overrides:
refreshFunctionCategory in class org.okiproject.serviceapi.roles.RolesFactory

getFunctionsInCategory

public org.okiproject.serviceapi.roles.Functions getFunctionsInCategory(org.okiproject.serviceapi.roles.FunctionCategory functionCategory)
                                                                 throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a FunctionCategory returns an enumeration of Functions from the Roles DB
Overrides:
getFunctionsInCategory in class org.okiproject.serviceapi.roles.RolesFactory

getCurrentQualifierFields

public org.okiproject.serviceapi.roles.Field[] getCurrentQualifierFields()
                                                                  throws java.lang.Exception
Overrides:
getCurrentQualifierFields in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
the current list of Qualifier fields.

createQualifier

public org.okiproject.serviceapi.roles.Qualifier createQualifier(org.okiproject.serviceapi.roles.QualifierType qualifierType,
                                                                 java.lang.String qualifierCode,
                                                                 java.lang.String description,
                                                                 org.okiproject.serviceapi.roles.Qualifier parent)
                                                          throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Creates a new Qualifier in the Roles DB. This is different from making a new instance of a Qualifier object locally as the Qualifier will be inserted into the Roles DB.
Overrides:
createQualifier in class org.okiproject.serviceapi.roles.RolesFactory

deleteQualifier

public void deleteQualifier(org.okiproject.serviceapi.roles.Qualifier qualifier)
                     throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Deletes an existing qualifier in the Roles DB.
Overrides:
deleteQualifier in class org.okiproject.serviceapi.roles.RolesFactory

isQualifierFoundInRoles

public java.lang.Boolean isQualifierFoundInRoles(org.okiproject.serviceapi.roles.Qualifier qualifier)
                                          throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Determines if this Qualifier has a matching Qualifier in the Roles DB.
Overrides:
isQualifierFoundInRoles in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
true indicates Qualifier is in the Roles DB as are its properties.

refreshQualifier

public void refreshQualifier(org.okiproject.serviceapi.roles.Qualifier qualifier)
                      throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Refreshes properties from a changing Roles DB.
Overrides:
refreshQualifier in class org.okiproject.serviceapi.roles.RolesFactory

updateQualifier

public void updateQualifier(org.okiproject.serviceapi.roles.Qualifier qualifier,
                            java.lang.String newQualifierCode,
                            java.lang.String newDescription)
                     throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Updates one or more fields in an existing qualifier in the Roles DB.
Overrides:
updateQualifier in class org.okiproject.serviceapi.roles.RolesFactory

isQualifierTypeFoundInRoles

public java.lang.Boolean isQualifierTypeFoundInRoles(org.okiproject.serviceapi.roles.QualifierType qualifierType)
                                              throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Determines if this QualifierType has a matching QualifierType in the Roles DB.
Overrides:
isQualifierTypeFoundInRoles in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns:
true indicates QualifierType is in the Roles DB as are its properties.

refreshQualifierType

public void refreshQualifierType(org.okiproject.serviceapi.roles.QualifierType qualifierType)
                          throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Refreshes QualifierType properties from a changing Roles DB.
Overrides:
refreshQualifierType in class org.okiproject.serviceapi.roles.RolesFactory

getRootQualifier

public org.okiproject.serviceapi.roles.Qualifier getRootQualifier(org.okiproject.serviceapi.roles.QualifierType qualifierType)
                                                           throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given a Qualifier Type returns the qualifier that is the root of the tree of qualifiers of this type.
Overrides:
getRootQualifier in class org.okiproject.serviceapi.roles.RolesFactory

getQualifierChildren

public org.okiproject.serviceapi.roles.Qualifiers getQualifierChildren(org.okiproject.serviceapi.roles.Qualifier qualifier)
                                                                throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Given an existing qualifier returns a list of its child qualifiers.
Overrides:
getQualifierChildren in class org.okiproject.serviceapi.roles.RolesFactory

newQualifier

public org.okiproject.serviceapi.roles.Qualifier newQualifier(org.okiproject.serviceapi.roles.QualifierType qualifierType,
                                                              java.lang.String qualifierCode)
                                                       throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns a new instance of org.okiproject.serviceapi.roles.Qualifier. The instance may or may not exist in the Roles DB. This is a local instance.
Overrides:
newQualifier in class org.okiproject.serviceapi.roles.RolesFactory

newQualifier

public org.okiproject.serviceapi.roles.Qualifier newQualifier(java.lang.Object id)
                                                       throws java.lang.Exception

newQualifier

public org.okiproject.serviceapi.roles.Qualifier newQualifier(java.lang.String qualifierType,
                                                              java.lang.String qualifierCode)
                                                       throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns a new instance of org.okiproject.serviceapi.roles.Qualifier. The instance may or may not exist in the Roles DB. This is a local instance.
Overrides:
newQualifier in class org.okiproject.serviceapi.roles.RolesFactory

newQualifierType

public org.okiproject.serviceapi.roles.QualifierType newQualifierType(java.lang.String qualifierType)
                                                               throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
Returns a new instance of org.okiproject.serviceapi.roles.QualifierType. The instance may or may not exist in the Roles DB. This is a local instance.
Overrides:
newQualifierType in class org.okiproject.serviceapi.roles.RolesFactory

newGrantPrivilege

public org.okiproject.serviceapi.roles.GrantPrivilege newGrantPrivilege(java.lang.String grantPrivilege)
                                                                 throws java.lang.Exception
Description copied from class: org.okiproject.serviceapi.roles.RolesFactory
The instance created is local to the application. It may or may not exist in the Roles DB.
Overrides:
newGrantPrivilege in class org.okiproject.serviceapi.roles.RolesFactory
Following copied from class: org.okiproject.serviceapi.roles.RolesFactory
Parameters:
grantPrivilege - may be one of the following:
Returns:
a new instance of GrantPrivilege. org.okiproject.serviceapi.roles.GrantPrivilege.NOTGRANTABLE org.okiproject.serviceapi.roles.GrantPrivilege.GRANTABLE org.okiproject.serviceapi.roles.GrantPrivilege.GRANTABLEFORGRANTING