DODS 7.3 API

org.webdocwf.dods.access
Class SecureDO

java.lang.Object
  extended by com.lutris.appserver.server.sql.CoreDO
      extended by com.lutris.appserver.server.sql.CloneableDO
          extended by com.lutris.dods.builder.generator.dataobject.GenericDO
              extended by org.webdocwf.dods.access.SecureDO
All Implemented Interfaces:
com.lutris.appserver.server.sql.Transaction, java.io.Serializable, java.lang.Cloneable

public abstract class SecureDO
extends GenericDO

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.lutris.dods.builder.generator.dataobject.GenericDO
colChanged, dirty
 
Fields inherited from class com.lutris.appserver.server.sql.CoreDO
originalData, persistent, versioning
 
Constructor Summary
SecureDO()
           
SecureDO(boolean isView)
           
SecureDO(com.lutris.appserver.server.sql.ObjectId id)
           
SecureDO(java.sql.ResultSet rs)
           
SecureDO(java.lang.String dbName)
           
SecureDO(java.lang.String dbName, boolean isView)
           
SecureDO(java.lang.String dbName, com.lutris.appserver.server.sql.ObjectId id)
           
SecureDO(java.lang.String dbName, java.sql.ResultSet rs)
           
 
Method Summary
 void assertDOCopyAccess(User usr)
          Ensure that the given user is allowed to copy the DO
 void assertDODeleteAccess(User usr)
          Ensure that the given user is allowed to delete the DO
 void assertDOGetAccess(User usr)
          Ensure that the given user is allowed to read the DO existance
protected  void assertDOGetDOValueAccess(java.lang.String attrName, boolean value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, byte[] value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, byte value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, double value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, float value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, int value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, long value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  void assertDOGetDOValueAccess(java.lang.String attrName, java.lang.Object value, User usr)
          Dummy method for generated datatypes WebDocWf extension
 void assertDOGetDOValueAccess(java.lang.String attrName, SecureDO value, User usr)
          Ensure that the given user is allowed to read the object in a given pointer
protected  void assertDOGetDOValueAccess(java.lang.String attrName, short value, User usr)
          Dummy method for generated datatypes WebDocWf extension
 void assertDOGetVersionAccess(User usr)
          Ensure that the given user is allowed to access the version number
 void assertDOIsReadOnlyAccess(User usr)
          Ensure that the given user is allowed to read the readonly flag
 void assertDOMakeReadOnlyAccess(User usr)
          Ensure that the given user is allowed to set the object readonly
 void assertDOMakeReadWriteAccess(User usr)
          Ensure that the given user is allowed to set the object readwrite
protected abstract  void checkLoad()
          Load the actual DO data if necessary.
abstract  void delete()
          Deletes the DO from its table.
abstract  void delete(com.lutris.appserver.server.sql.DBTransaction dbt)
          Deletes the DO from its table.
 void delete(com.lutris.appserver.server.sql.DBTransaction dbt, User usr)
          Deletes the DO from its table.
 void delete(User usr)
          Deletes the DO from its table.
abstract  java.lang.String get_Handle()
          Subclass should override this method if wants to use it.
 java.lang.String get_Handle(User usr)
          The get_Handle() method is used to set the value for each GUI option, and the hasMatchingHandle() methods are used to lookup the Data Object when the selection has been made.
 int get_Version()
          Returns this object's version.
 int get_Version(User usr)
          Returns this object's version.
 java.lang.String getHandle(User usr)
          Deprecated. Use get_Handle() instead.
 int getVersion()
          Deprecated. Use get_Version()
 boolean hasDOCopyAccess(User usr)
          Check whether the given user is allowed to copy the DO
 boolean hasDODeleteAccess(User usr)
          Check if the given user is allowed to delete the DO
 boolean hasDOGetAccess(User usr)
          Check whether the given user is allowed to read the DO existance
 boolean hasDOGetAttrAccess(java.lang.String attrName, boolean value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, byte[] value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, byte value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, double value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, float value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, int value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, long value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, java.lang.Object value, User usr)
          Check whether the given user is allowed to read the attribute and the value
 boolean hasDOGetAttrAccess(java.lang.String attrName, short value, User usr)
          Check whether the given user is allowed to read the attribute and the value
protected  boolean hasDOGetDOValueAccess(boolean value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(byte[] value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(byte value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(double value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(float value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(int value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(long value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(java.lang.Object value, User usr)
          Dummy method for generated datatypes WebDocWf extension
protected  boolean hasDOGetDOValueAccess(SecureDO value, User usr)
          Check whether the given user is allowed to read the object in a given pointer
protected  boolean hasDOGetDOValueAccess(short value, User usr)
          Dummy method for generated datatypes WebDocWf extension
 boolean hasDOGetVersionAccess(User usr)
          Check whether the given user is allowed to access the version number
 boolean hasDOIsReadOnlyAccess(User usr)
          Check whether the given user is allowed to read the readonly flag
 boolean hasDOMakeReadOnlyAccess(User usr)
          Check whether the given user is allowed to set the object readonly
 boolean hasDOMakeReadWriteAccess(User usr)
          Check whether the given user is allowed to set the object readwrite
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, boolean oldValue, boolean newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, byte[] oldValue, byte[] newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, byte oldValue, byte newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, double oldValue, double newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, float oldValue, float newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, int oldValue, int newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, long oldValue, long newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, java.lang.Object oldValue, java.lang.Object newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
protected  boolean hasDOSetAttrAccess(java.lang.String attrName, short oldValue, short newValue, User usr)
          Check whether the given user is allowed to update the attribute and the value
abstract  boolean hasMatchingHandle(java.lang.String handle)
           
 boolean hasMatchingHandle(java.lang.String handle, User usr)
          hasMatchingHandle
 boolean hasQueryFindAccess(User usr)
          Check whether the given user is allowed to find the object using a query
abstract  boolean isReadOnly()
          isReadOnly() Returns true if the data for this object has been marked read-only.
 boolean isReadOnly(User usr)
          isReadOnly() Returns true if the data for this object has been marked read-only.
abstract  void makeReadOnly()
          makeReadOnly() Mark the object as readonly WebDocWf extension
 void makeReadOnly(User usr)
          makeReadOnly() Mark the object as readonly
abstract  void makeReadWrite()
          Mark the object as readwrite WebDocWf extension
 void makeReadWrite(User usr)
          Mark the object as readwrite
 
Methods inherited from class com.lutris.dods.builder.generator.dataobject.GenericDO
_tr_, addToTransactionCache, cloneUnique, compareCond, copyBigDecimal, copyByteArray, copyDate, copyObjectId, copyString, copyTime, copyTimestamp, createDO, createDO, executeDelete, executeInsert, executeUpdate, finalizeInsert, finalizeUpdate, get_CacheHandle, get_Data, get_OriginDatabase, get_primaryKeyName, getData, getHandle, getOriginDatabase, getPrimaryKeyName, isDirty, isExecutePartially, isNewDataDifferent_BigDecimal, isNewDataDifferent_boolean, isNewDataDifferent_byte, isNewDataDifferent_bytes, isNewDataDifferent_DO, isNewDataDifferent_double, isNewDataDifferent_float, isNewDataDifferent_int, isNewDataDifferent_java_math_BigDecimal, isNewDataDifferent_java_sql_Date, isNewDataDifferent_java_sql_Time, isNewDataDifferent_java_sql_Timestamp, isNewDataDifferent_long, isNewDataDifferent_short, isNewDataDifferent_String, makeIdentical, markClean, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, markNewValue, originalData_set, printMsg, set_Data, set_OId, setData, setExecutePartially, setPrepStmtParam_BigDecimal, setPrepStmtParam_boolean, setPrepStmtParam_byte, setPrepStmtParam_bytes, setPrepStmtParam_DO, setPrepStmtParam_double, setPrepStmtParam_float, setPrepStmtParam_int, setPrepStmtParam_java_math_BigDecimal, setPrepStmtParam_java_sql_Date, setPrepStmtParam_java_sql_Time, setPrepStmtParam_java_sql_Timestamp, setPrepStmtParam_long, setPrepStmtParam_ObjectId, setPrepStmtParam_short, setPrepStmtParam_String, toString, writeXML
 
Methods inherited from class com.lutris.appserver.server.sql.CloneableDO
clone
 
Methods inherited from class com.lutris.appserver.server.sql.CoreDO
addToCache, deleteFromCache, disableVersioning, dumpData, evict, executeLockingStatement, finalizeDelete, get_NewVersion, get_OId, get_OIdColumnName, get_versionColumnName, getDeleteStatement, getInsertStatement, getNewVersion, getOId, getOIdColumnName, getOriginalVersion, getTableName, getUpdateStatement, getVersionColumnName, isPersistent, makeInvisible, makeVisible, objectIdentityType, originalData_get, refresh, set_NewVersion, set_OIdColumnName, set_Version, set_versionColumnName, setNewVersion, setOId, setOIdColumnName, setPersistent, setVersion, setVersionColumnName, updateCache
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SecureDO

public SecureDO()
         throws com.lutris.appserver.server.sql.DatabaseManagerException,
                com.lutris.appserver.server.sql.ObjectIdException
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException
com.lutris.appserver.server.sql.ObjectIdException

SecureDO

public SecureDO(java.lang.String dbName)
         throws com.lutris.appserver.server.sql.DatabaseManagerException,
                com.lutris.appserver.server.sql.ObjectIdException
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException
com.lutris.appserver.server.sql.ObjectIdException

SecureDO

public SecureDO(boolean isView)
         throws com.lutris.appserver.server.sql.ObjectIdException,
                com.lutris.appserver.server.sql.DatabaseManagerException
Throws:
com.lutris.appserver.server.sql.ObjectIdException
com.lutris.appserver.server.sql.DatabaseManagerException

SecureDO

public SecureDO(java.lang.String dbName,
                boolean isView)
         throws com.lutris.appserver.server.sql.ObjectIdException,
                com.lutris.appserver.server.sql.DatabaseManagerException
Throws:
com.lutris.appserver.server.sql.ObjectIdException
com.lutris.appserver.server.sql.DatabaseManagerException

SecureDO

public SecureDO(com.lutris.appserver.server.sql.ObjectId id)
         throws com.lutris.appserver.server.sql.ObjectIdException,
                com.lutris.appserver.server.sql.DatabaseManagerException
Throws:
com.lutris.appserver.server.sql.ObjectIdException
com.lutris.appserver.server.sql.DatabaseManagerException

SecureDO

public SecureDO(java.lang.String dbName,
                com.lutris.appserver.server.sql.ObjectId id)
         throws com.lutris.appserver.server.sql.ObjectIdException,
                com.lutris.appserver.server.sql.DatabaseManagerException
Throws:
com.lutris.appserver.server.sql.ObjectIdException
com.lutris.appserver.server.sql.DatabaseManagerException

SecureDO

public SecureDO(java.sql.ResultSet rs)
         throws java.sql.SQLException,
                com.lutris.appserver.server.sql.ObjectIdException,
                com.lutris.appserver.server.sql.DatabaseManagerException
Throws:
java.sql.SQLException
com.lutris.appserver.server.sql.ObjectIdException
com.lutris.appserver.server.sql.DatabaseManagerException

SecureDO

public SecureDO(java.lang.String dbName,
                java.sql.ResultSet rs)
         throws java.sql.SQLException,
                com.lutris.appserver.server.sql.ObjectIdException,
                com.lutris.appserver.server.sql.DatabaseManagerException
Throws:
java.sql.SQLException
com.lutris.appserver.server.sql.ObjectIdException
com.lutris.appserver.server.sql.DatabaseManagerException
Method Detail

delete

public abstract void delete()
                     throws java.sql.SQLException,
                            com.lutris.appserver.server.sql.DatabaseManagerException,
                            com.lutris.dods.builder.generator.query.DataObjectException,
                            com.lutris.dods.builder.generator.query.RefAssertionException,
                            com.lutris.appserver.server.sql.DBRowUpdateException,
                            com.lutris.dods.builder.generator.query.QueryException
Deletes the DO from its table.

Overrides:
delete in class GenericDO
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.
com.lutris.dods.builder.generator.query.RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
com.lutris.dods.builder.generator.query.DataObjectException
com.lutris.appserver.server.sql.DBRowUpdateException
com.lutris.dods.builder.generator.query.QueryException

delete

public abstract void delete(com.lutris.appserver.server.sql.DBTransaction dbt)
                     throws java.sql.SQLException,
                            com.lutris.appserver.server.sql.DatabaseManagerException,
                            com.lutris.dods.builder.generator.query.DataObjectException,
                            com.lutris.dods.builder.generator.query.RefAssertionException,
                            com.lutris.appserver.server.sql.DBRowUpdateException,
                            com.lutris.dods.builder.generator.query.QueryException
Deletes the DO from its table. The transaction is likely provided by the delete() method of another DO which references this DO.

Parameters:
dbt - The transaction object to use for this operation.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.
com.lutris.appserver.server.sql.DBRowUpdateException - if a version error occurs.
com.lutris.dods.builder.generator.query.RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
com.lutris.dods.builder.generator.query.DataObjectException
com.lutris.dods.builder.generator.query.QueryException

checkLoad

protected abstract void checkLoad()
                           throws com.lutris.dods.builder.generator.query.DataObjectException
Load the actual DO data if necessary. Called by get/set methods.

Throws:
com.lutris.dods.builder.generator.query.DataObjectException - If a data access error occurs.

get_Handle

public abstract java.lang.String get_Handle()
                                     throws com.lutris.appserver.server.sql.DatabaseManagerException
Description copied from class: GenericDO
Subclass should override this method if wants to use it. Returns DO's handle.

Overrides:
get_Handle in class GenericDO
Returns:
DO's handle.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException

hasMatchingHandle

public abstract boolean hasMatchingHandle(java.lang.String handle)

isReadOnly

public abstract boolean isReadOnly()
isReadOnly() Returns true if the data for this object has been marked read-only.


makeReadOnly

public abstract void makeReadOnly()
makeReadOnly() Mark the object as readonly WebDocWf extension


makeReadWrite

public abstract void makeReadWrite()
Mark the object as readwrite WebDocWf extension


delete

public void delete(User usr)
            throws java.sql.SQLException,
                   com.lutris.appserver.server.sql.DatabaseManagerException,
                   com.lutris.dods.builder.generator.query.DataObjectException,
                   com.lutris.dods.builder.generator.query.RefAssertionException,
                   com.lutris.appserver.server.sql.DBRowUpdateException,
                   com.lutris.dods.builder.generator.query.QueryException,
                   AccessException
Deletes the DO from its table.

Parameters:
usr - The user for security checks
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.
com.lutris.dods.builder.generator.query.RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
AccessException - The user is not allowed to delete the DO This is a WebDocWf extension for DODS row instance security
com.lutris.dods.builder.generator.query.DataObjectException
com.lutris.appserver.server.sql.DBRowUpdateException
com.lutris.dods.builder.generator.query.QueryException

assertDODeleteAccess

public void assertDODeleteAccess(User usr)
                          throws AccessException
Ensure that the given user is allowed to delete the DO

Parameters:
usr - The user for security checks
Throws:
AccessException - The user is not allowed to delete the DO This is a WebDocWf extension for DODS row instance security

hasDODeleteAccess

public boolean hasDODeleteAccess(User usr)
                          throws AccessEvalException
Check if the given user is allowed to delete the DO

Parameters:
usr - The user for security checks
Returns:
Whether the user is allowed to delete this DO
Throws:
AccessEvalException - Error during access evaluation This is a WebDocWf extension for DODS row instance security

delete

public void delete(com.lutris.appserver.server.sql.DBTransaction dbt,
                   User usr)
            throws java.sql.SQLException,
                   com.lutris.appserver.server.sql.DatabaseManagerException,
                   com.lutris.dods.builder.generator.query.DataObjectException,
                   com.lutris.dods.builder.generator.query.RefAssertionException,
                   com.lutris.appserver.server.sql.DBRowUpdateException,
                   com.lutris.dods.builder.generator.query.QueryException,
                   AccessException
Deletes the DO from its table.

Parameters:
usr - The user for security checks
dbt - The transaction object to use for this operation.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - if a Transaction can not be created.
com.lutris.dods.builder.generator.query.RefAssertionException - thrown by okTo method.
java.sql.SQLException - if any SQL errors occur.
AccessException - The user is not allowed to delete the DO This is a WebDocWf extension for DODS row instance security
com.lutris.dods.builder.generator.query.DataObjectException
com.lutris.appserver.server.sql.DBRowUpdateException
com.lutris.dods.builder.generator.query.QueryException

assertDOCopyAccess

public void assertDOCopyAccess(User usr)
                        throws AccessException
Ensure that the given user is allowed to copy the DO

Parameters:
usr - The user for security check
Throws:
AccessException - The user is not allowed to make a copy WebDocWf extension

hasDOCopyAccess

public boolean hasDOCopyAccess(User usr)
                        throws AccessEvalException
Check whether the given user is allowed to copy the DO

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to copy the DO WebDocWf extension
Throws:
AccessEvalException

get_Handle

public java.lang.String get_Handle(User usr)
                            throws com.lutris.appserver.server.sql.DatabaseManagerException,
                                   AccessException
The get_Handle() method is used to set the value for each GUI option, and the hasMatchingHandle() methods are used to lookup the Data Object when the selection has been made.

Parameters:
usr - The user for security check
Returns:
id of this DO as a string
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - If a connection to the database cannot be established, etc.
AccessException - The user is not allowed to read the object existance WebDocWf extension

getHandle

public java.lang.String getHandle(User usr)
                           throws com.lutris.appserver.server.sql.DatabaseManagerException,
                                  AccessException
Deprecated. Use get_Handle() instead.

The getHandle() method is used to set the value for each GUI option, and the hasMatchingHandle() methods are used to lookup the Data Object when the selection has been made.

Parameters:
usr - The user for security check
Returns:
id of this DO as a string
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - If a connection to the database cannot be established, etc.
AccessException - The user is not allowed to read the object existance WebDocWf extension

hasMatchingHandle

public boolean hasMatchingHandle(java.lang.String handle,
                                 User usr)
                          throws AccessException
hasMatchingHandle

Parameters:
handle - String version of DO id
usr - The user for security check
Returns:
boolean True if the string version of the id of this DO matches passed handle
Throws:
AccessException - The user is not allowed to read the object existance WebDocWf extension

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  java.lang.Object value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  boolean value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  byte value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  short value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  int value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  long value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  float value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  double value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOGetAttrAccess

public boolean hasDOGetAttrAccess(java.lang.String attrName,
                                  byte[] value,
                                  User usr)
                           throws AccessEvalException
Check whether the given user is allowed to read the attribute and the value

Parameters:
attrName - The name of the attribute
value - The current value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to read the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     java.lang.Object oldValue,
                                     java.lang.Object newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     boolean oldValue,
                                     boolean newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     byte oldValue,
                                     byte newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     short oldValue,
                                     short newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     int oldValue,
                                     int newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     long oldValue,
                                     long newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     float oldValue,
                                     float newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     double oldValue,
                                     double newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

hasDOSetAttrAccess

protected boolean hasDOSetAttrAccess(java.lang.String attrName,
                                     byte[] oldValue,
                                     byte[] newValue,
                                     User usr)
                              throws AccessEvalException
Check whether the given user is allowed to update the attribute and the value

Parameters:
attrName - The name of the attribute
oldValue - The current value of the attribute
newValue - The new value of the attribute
usr - The user for security check
Returns:
Whether the given user is allowed to update the attribute WebDocWf extension
Throws:
AccessEvalException

assertDOGetDOValueAccess

public void assertDOGetDOValueAccess(java.lang.String attrName,
                                     SecureDO value,
                                     User usr)
                              throws AccessException
Ensure that the given user is allowed to read the object in a given pointer

Parameters:
attrName - The name of the attribute
value - The object in the pointer
usr - The user for security check
Throws:
AccessException - The user is not allowed to read the object WebDocWf extension

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(SecureDO value,
                                        User usr)
                                 throws AccessEvalException
Check whether the given user is allowed to read the object in a given pointer

Parameters:
value - The object in the pointer
usr - The user for security check
Returns:
Whether the given user is allowed to read the object WebDocWf extension
Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(java.lang.Object value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(boolean value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(byte value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(short value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(int value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(long value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(float value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(double value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

hasDOGetDOValueAccess

protected boolean hasDOGetDOValueAccess(byte[] value,
                                        User usr)
                                 throws AccessEvalException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessEvalException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        java.lang.Object value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        boolean value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        byte value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        short value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        int value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        long value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        float value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        double value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

assertDOGetDOValueAccess

protected void assertDOGetDOValueAccess(java.lang.String attrName,
                                        byte[] value,
                                        User usr)
                                 throws AccessException
Dummy method for generated datatypes WebDocWf extension

Throws:
AccessException

hasQueryFindAccess

public boolean hasQueryFindAccess(User usr)
                           throws AccessEvalException
Check whether the given user is allowed to find the object using a query

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to find the object WebDocWf extension
Throws:
AccessEvalException

getVersion

public int getVersion()
Deprecated. Use get_Version()

Overrides:
getVersion in class CoreDO
Returns:
this object's version.

get_Version

public int get_Version()
Returns this object's version.

Overrides:
get_Version in class CoreDO
Returns:
this object's version. WebDocWf extension

get_Version

public int get_Version(User usr)
                throws AccessException
Returns this object's version.

Parameters:
usr - The user for security check
Returns:
this object's version. WebDocWf extension
Throws:
AccessException

assertDOGetVersionAccess

public void assertDOGetVersionAccess(User usr)
                              throws AccessException
Ensure that the given user is allowed to access the version number

Parameters:
usr - The user for security check WebDocWf extension
Throws:
AccessException

hasDOGetVersionAccess

public boolean hasDOGetVersionAccess(User usr)
                              throws AccessEvalException
Check whether the given user is allowed to access the version number

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to access the version number WebDocWf extension
Throws:
AccessEvalException

isReadOnly

public boolean isReadOnly(User usr)
                   throws AccessException
isReadOnly() Returns true if the data for this object has been marked read-only.

Parameters:
usr - The user for security check
Returns:
Whether the data for this object has been marked read-only. WebDocWf extension
Throws:
AccessException

assertDOIsReadOnlyAccess

public void assertDOIsReadOnlyAccess(User usr)
                              throws AccessException
Ensure that the given user is allowed to read the readonly flag

Parameters:
usr - The user for security check WebDocWf extension
Throws:
AccessException

hasDOIsReadOnlyAccess

public boolean hasDOIsReadOnlyAccess(User usr)
                              throws AccessEvalException
Check whether the given user is allowed to read the readonly flag

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to read the readonly flag WebDocWf extension
Throws:
AccessEvalException

assertDOGetAccess

public void assertDOGetAccess(User usr)
                       throws AccessException
Ensure that the given user is allowed to read the DO existance

Parameters:
usr - The user for security check
Throws:
AccessException - The user is not allowed to read the instance existance WebDocWf extension

hasDOGetAccess

public boolean hasDOGetAccess(User usr)
                       throws AccessEvalException
Check whether the given user is allowed to read the DO existance

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to read the DO existance WebDocWf extension
Throws:
AccessEvalException

makeReadOnly

public void makeReadOnly(User usr)
                  throws AccessException
makeReadOnly() Mark the object as readonly

Parameters:
usr - The user for security check WebDocWf extension
Throws:
AccessException

assertDOMakeReadOnlyAccess

public void assertDOMakeReadOnlyAccess(User usr)
                                throws AccessException
Ensure that the given user is allowed to set the object readonly

Parameters:
usr - The user for security check WebDocWf extension
Throws:
AccessException

hasDOMakeReadOnlyAccess

public boolean hasDOMakeReadOnlyAccess(User usr)
                                throws AccessEvalException
Check whether the given user is allowed to set the object readonly

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to set the object readonly WebDocWf extension
Throws:
AccessEvalException

makeReadWrite

public void makeReadWrite(User usr)
                   throws AccessException
Mark the object as readwrite

Parameters:
usr - The user for security check WebDocWf extension
Throws:
AccessException

assertDOMakeReadWriteAccess

public void assertDOMakeReadWriteAccess(User usr)
                                 throws AccessException
Ensure that the given user is allowed to set the object readwrite

Parameters:
usr - The user for security check WebDocWf extension
Throws:
AccessException

hasDOMakeReadWriteAccess

public boolean hasDOMakeReadWriteAccess(User usr)
                                 throws AccessEvalException
Check whether the given user is allowed to set the object readwrite

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to set the object readwrite WebDocWf extension
Throws:
AccessEvalException

DODS 7.3 API