er.rest.entityDelegates
Class ERXUnsafeRestEntityDelegate

java.lang.Object
  er.rest.entityDelegates.ERXAbstractRestEntityDelegate
      er.rest.entityDelegates.ERXStandardRestEntityDelegate
          er.rest.entityDelegates.ERXUnsafeRestEntityDelegate

All Implemented Interfaces:

IERXRestEntityDelegate, IERXRestSecurityDelegate

public class ERXUnsafeRestEntityDelegate
extends ERXStandardRestEntityDelegate

ERXUnsafeRestEntityDelegate should NEVER be used in production. This is an entity delegate implementation designed to allow you to explore the features of ERRest without having to actually write custom delegates. This implementation allows full access to read, insert, update, and delegate any object in any model in your system that it is assigned as a delegate for. It will throw an exception on creation if ERXApplication.erxApplication().isDevelopmentMode() is false.

Author:

mschrag

Constructor Summary

ERXUnsafeRestEntityDelegate()
Constructs an ERXUnsafeRestEntityDelegate.

ERXUnsafeRestEntityDelegate(boolean allowProductionUse)
Constructs an ERXUnsafeRestEntityDelegate.

Method Summary

static com.webobjects.foundation.NSArray<java.lang.String>	allPropertyNames(com.webobjects.eoaccess.EOEntity entity, boolean includeToMany)
boolean	canDeleteObject(com.webobjects.eoaccess.EOEntity entity, com.webobjects.eocontrol.EOEnterpriseObject eo, ERXRestContext context) Returns whether or not the given object can be deleted.
boolean	canInsertObject(com.webobjects.eoaccess.EOEntity entity, ERXRestContext context) Returns whether or not the caller is allowed to insert a new object of the given entity.
boolean	canInsertObject(com.webobjects.eoaccess.EOEntity parentEntity, java.lang.Object parentObject, java.lang.String parentKey, com.webobjects.eoaccess.EOEntity entity, ERXRestContext context) Returns whether or not a new object can be inserted into the specified relationship of an existing object.
boolean	canInsertProperty(com.webobjects.eoaccess.EOEntity entity, com.webobjects.eocontrol.EOEnterpriseObject eo, java.lang.String propertyName, ERXRestContext context) Returns true if propertyName is declared as an insert property.
boolean	canUpdateObject(com.webobjects.eoaccess.EOEntity entity, com.webobjects.eocontrol.EOEnterpriseObject eo, ERXRestContext context) Returns whether or not the given object can be updated.
boolean	canUpdateProperty(com.webobjects.eoaccess.EOEntity entity, com.webobjects.eocontrol.EOEnterpriseObject eo, java.lang.String propertyName, ERXRestContext context) Returns true if propertyName is declared as an update property.
boolean	canViewObject(com.webobjects.eoaccess.EOEntity entity, com.webobjects.eocontrol.EOEnterpriseObject eo, ERXRestContext context) Returns whether or not the given object can be seen.
boolean	canViewProperty(com.webobjects.eoaccess.EOEntity entity, java.lang.Object obj, java.lang.String propertyName, ERXRestContext context) Returns true if propertyName is declared as a view property.
void	initializeEntityNamed(java.lang.String entityName) Do nothing by default
com.webobjects.foundation.NSArray	objectsForEntity(com.webobjects.eoaccess.EOEntity entity, ERXRestContext context) Returns an array of all of the EOs visible to the user for the given entity.
com.webobjects.foundation.NSArray	visibleObjects(com.webobjects.eoaccess.EOEntity parentEntity, java.lang.Object parent, java.lang.String key, com.webobjects.eoaccess.EOEntity entity, com.webobjects.foundation.NSArray objects, ERXRestContext context) Given an array, this method filters the array based on the callers permission level.

Methods inherited from class er.rest.entityDelegates.ERXStandardRestEntityDelegate

addInsertPropertyName, addUpdatePropertyName, addViewPropertyName, defaultIDAttributeName, entityAliasForEntityNamed, hasViewProperties, idAttributeName, inserted, loadDetailsPropertiesAsViewPropertiesForEntityNamed, loadInsertPropertiesForEntityNamed, loadUpdatePropertiesForEntityNamed, loadViewPropertiesForEntityNamed, nextEntity, propertyAliasForPropertyNamed, propertyNameForPropertyAlias, qualifierFromContext, setDefaultIDAttributeName, sortOrderingsFromContext, updated, updatePropertyAliasForPropertyNamed

Methods inherited from class er.rest.entityDelegates.ERXAbstractRestEntityDelegate

_cascadingValue, _displayDetailsFromProperties, _displayPropertiesFromProperties, _isEOID, _objectWithKey, _updateArrayFromDocument, _updatePropertiesFromDocument, _updateRelationshipFromDocument, allPossiblePropertyNamesOnEarth, cascadingValue, delete, displayDetails, displayProperties, formatAttributeValue, idForEO, idForNode, insertObjectFromDocument, isEOID, objectForNode, objectWithKey, objectWithKey, parseAttributeValue, preprocess, processObjectFromDocument, stringIDForEO, takeValueForKey, updateArrayFromDocument, updateObjectFromDocument, valueForKey

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXUnsafeRestEntityDelegate

public ERXUnsafeRestEntityDelegate()

Constructs an ERXUnsafeRestEntityDelegate.

ERXUnsafeRestEntityDelegate

public ERXUnsafeRestEntityDelegate(boolean allowProductionUse)

Constructs an ERXUnsafeRestEntityDelegate.

Parameters:

allowProductionUse - if true, this can be used in production without throwing an exception. BE VERY CAREFUL.

Method Detail

initializeEntityNamed

public void initializeEntityNamed(java.lang.String entityName)

Description copied from class: ERXAbstractRestEntityDelegate

Do nothing by default

Specified by:

initializeEntityNamed in interface IERXRestEntityDelegate

Overrides:

initializeEntityNamed in class ERXAbstractRestEntityDelegate

Parameters:

entityName - the name of the entity to initialize

canInsertProperty

public boolean canInsertProperty(com.webobjects.eoaccess.EOEntity entity,
                                 com.webobjects.eocontrol.EOEnterpriseObject eo,
                                 java.lang.String propertyName,
                                 ERXRestContext context)

Description copied from class: ERXStandardRestEntityDelegate

Returns true if propertyName is declared as an insert property.

Specified by:

canInsertProperty in interface IERXRestSecurityDelegate

Overrides:

canInsertProperty in class ERXStandardRestEntityDelegate

Parameters:

entity - the entity

eo - the object to check

propertyName - the property name to check

context - the rest context

Returns:

true if propertyName is declared as an insert property

canUpdateProperty

public boolean canUpdateProperty(com.webobjects.eoaccess.EOEntity entity,
                                 com.webobjects.eocontrol.EOEnterpriseObject eo,
                                 java.lang.String propertyName,
                                 ERXRestContext context)

Description copied from class: ERXStandardRestEntityDelegate

Returns true if propertyName is declared as an update property.

Specified by:

canUpdateProperty in interface IERXRestSecurityDelegate

Overrides:

canUpdateProperty in class ERXStandardRestEntityDelegate

Parameters:

entity - the entity

eo - the object to check

propertyName - the property name to check

context - the rest context

Returns:

true if propertyName is declared as an update property

objectsForEntity

public com.webobjects.foundation.NSArray objectsForEntity(com.webobjects.eoaccess.EOEntity entity,
                                                          ERXRestContext context)

Description copied from interface: IERXRestEntityDelegate

Returns an array of all of the EOs visible to the user for the given entity.

Parameters:

entity - the entity to fetch

context - the rest context

Returns:

the array of EOs

canInsertObject

public boolean canInsertObject(com.webobjects.eoaccess.EOEntity entity,
                               ERXRestContext context)

Description copied from interface: IERXRestSecurityDelegate

Returns whether or not the caller is allowed to insert a new object of the given entity. This variant is called if the caller tries to insert an object without traversing a keypath -- that is, a top level insert. You can return false from this without implying that canInsertObject(..., parentObject, parentKey ..) returns false -- the two are mutually exclusive.

Parameters:

entity - the entity of the object to insert

context - the rest context

Returns:

whether or not a new object can be inserted

canInsertObject

public boolean canInsertObject(com.webobjects.eoaccess.EOEntity parentEntity,
                               java.lang.Object parentObject,
                               java.lang.String parentKey,
                               com.webobjects.eoaccess.EOEntity entity,
                               ERXRestContext context)

Description copied from interface: IERXRestSecurityDelegate

Returns whether or not a new object can be inserted into the specified relationship of an existing object.

Parameters:

parentEntity - the entity of the parent

parentObject - the parent

parentKey - the name of the relationship on the parent

entity - the entity of the object to insert

context - the rest context

Returns:

whether or not a new object can be inserted

canDeleteObject

public boolean canDeleteObject(com.webobjects.eoaccess.EOEntity entity,
                               com.webobjects.eocontrol.EOEnterpriseObject eo,
                               ERXRestContext context)

Description copied from interface: IERXRestSecurityDelegate

Returns whether or not the given object can be deleted. This is called prior to calling canDeleteProperty on any properties and acts as a first line of defenese to completely cut-off access to an object for delete. Note that the actual meaning of "delete" can be defined in your delete method, so returning true for this does not *necessarily* mean the object will be deleted. Instead it just means you will allow access to the delete method.

Parameters:

entity - the entity of the object

eo - the object to check

context - the rest context

Returns:

whether or not the given object can be deleted

canUpdateObject

public boolean canUpdateObject(com.webobjects.eoaccess.EOEntity entity,
                               com.webobjects.eocontrol.EOEnterpriseObject eo,
                               ERXRestContext context)

Description copied from interface: IERXRestSecurityDelegate

Returns whether or not the given object can be updated. This is called prior to calling canUpdateProperty on any properties and acts as a first line of defenese to completely cut-off access to an object for update

Parameters:

entity - the entity of the object

eo - the object to check

context - the rest context

Returns:

whether or not the given object can be updated

canViewObject

public boolean canViewObject(com.webobjects.eoaccess.EOEntity entity,
                             com.webobjects.eocontrol.EOEnterpriseObject eo,
                             ERXRestContext context)

Description copied from interface: IERXRestSecurityDelegate

Returns whether or not the given object can be seen. This is called prior to calling canViewProperty on any properties and acts as a first line of defenese to completely cut-off access to an object.

Parameters:

entity - the entity of the object

eo - the object to check

context - the rest context

Returns:

whether or not the given object can be seen

canViewProperty

public boolean canViewProperty(com.webobjects.eoaccess.EOEntity entity,
                               java.lang.Object obj,
                               java.lang.String propertyName,
                               ERXRestContext context)

Description copied from class: ERXStandardRestEntityDelegate

Returns true if propertyName is declared as a view property.

Specified by:

canViewProperty in interface IERXRestSecurityDelegate

Overrides:

canViewProperty in class ERXStandardRestEntityDelegate

Parameters:

entity - the entity

obj - the object to check

propertyName - the property name to check

context - the rest context

Returns:

true if propertyName is declared as a view property

visibleObjects

public com.webobjects.foundation.NSArray visibleObjects(com.webobjects.eoaccess.EOEntity parentEntity,
                                                        java.lang.Object parent,
                                                        java.lang.String key,
                                                        com.webobjects.eoaccess.EOEntity entity,
                                                        com.webobjects.foundation.NSArray objects,
                                                        ERXRestContext context)

Description copied from interface: IERXRestEntityDelegate

Given an array, this method filters the array based on the callers permission level. This method should never return null. To cut off access to the array entirely, return NSArray.EmptyArray. This method is only called after having verified access to the specified key on the parent object.

Parameters:

parentEntity - the entity of the parent

parent - the parent object

key - the key in the parent that references this array

entity - the entity of the objects in the array

objects - the actual array of objects to filter

context - the rest context

Returns:

a filtered array

allPropertyNames

public static com.webobjects.foundation.NSArray<java.lang.String> allPropertyNames(com.webobjects.eoaccess.EOEntity entity,
                                                                                   boolean includeToMany)