Package com.caplin.datasource.interfaces

Interface DSPermission

All Superinterfaces:

DSData, DSPacket, DSSerializable, Iterable<DSField>

public interface DSPermission
extends DSData

Extends DSData to provide helper methods for sending Permissions.

An instance of DSPermission should define the Key field for the permission. Any number of field/value pairs can then be defined after the key field. The DSPermission will be passed whole to the authentication module when it reaches the liberator.

Creating one of these with the DSData.F_FILTER_TYPE2 flag will create a Permission update that will cause the specified Permission Key to be cleared.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DS_FIELDS_SEPARATOR	Field number that is used by DataSource to separate multiple updates within the same packet.

Fields inherited from interface com.caplin.datasource.interfaces.DSData

CONTAINER_TYPE, F_AUTH_UPDATE, F_AUTHGLOBAL, F_CHANGEDFIELDS, F_CLEAR_PERMISSIONS, F_CLEAR_TYPE2, F_CLEAR_TYPE3, F_CREATEOBJECT, F_CREATEPARENT, F_DELETE_PERMISSION, F_FILTER_TYPE2, F_FILTER_TYPE3, F_IMAGE, F_NONACTIVE, GENERIC_TYPE, NEWS_TYPE, PAGE_TYPE, PERMISSION_TYPE, RECORD_TYPE, STORY_TYPE, TYPE2_RECORD_TYPE, TYPE3_RECORD_TYPE, UNKNOWN_TYPE

Method Summary

Modifier and Type	Method	Description
void	addKeyField(String key)	Adds the String key as the Keyfield for this packet.
void	addPermissionData(String fieldName, char value)	Adds the String representation of the character value for the specified field name.
void	addPermissionData(String fieldName, char[] value)	Adds the String representation of the character array for the specified field name.
void	addPermissionData(String fieldName, double value)	Adds the String representation of the double value for the specified field name.
void	addPermissionData(String fieldName, float value)	Adds the String representation of the float value for the specified field name.
void	addPermissionData(String fieldName, int value)	Adds the String representation of the integer value for the specified field name.
void	addPermissionData(String fieldName, long value)	Adds the String representation of the long value for the specified field name.
void	addPermissionData(String fieldName, String value)	Adds the String value for the specified field name.
void	addPermissionSeparator()	Adds a separator allowing the cojoining of multiple permission updates into a single packet.
void	addPermissionSeperator()	Deprecated.

Methods inherited from interface com.caplin.datasource.interfaces.DSData

addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addData, addData, addData, addData, addData, addData, addData, addData, clearFields, count, elements, getFieldByFieldNumber, getFieldByFieldNumber, getFlags, getKeys, getSubject, getType, getValues, iterator, removeField, setFlags, setSubject, setType, updateData, updateData

Methods inherited from interface com.caplin.datasource.interfaces.DSPacket

send, sendDirect, sendToPeer

Methods inherited from interface com.caplin.datasource.interfaces.DSSerializable

toBytes

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

DS_FIELDS_SEPARATOR

static final int DS_FIELDS_SEPARATOR

Field number that is used by DataSource to separate multiple updates within the same packet.

See Also:

• Constant Field Values

Method Details

addKeyField

void addKeyField(String key)

Adds the String key as the Keyfield for this packet.

This should only be called as the first call to a DSPermission or after a call to addPermissionSeperator()

Parameters:

key - the Keyfield for this packet

addPermissionData

void addPermissionData(String fieldName,
 String value)

Adds the String value for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionData

void addPermissionData(String fieldName,
 char value)

Adds the String representation of the character value for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionData

void addPermissionData(String fieldName,
 char[] value)

Adds the String representation of the character array for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionData

void addPermissionData(String fieldName,
 double value)

Adds the String representation of the double value for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionData

void addPermissionData(String fieldName,
 float value)

Adds the String representation of the float value for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionData

void addPermissionData(String fieldName,
 int value)

Adds the String representation of the integer value for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionData

void addPermissionData(String fieldName,
 long value)

Adds the String representation of the long value for the specified field name.

Parameters:

fieldName - The field name.

value - The value to be stored in the field.

addPermissionSeparator

void addPermissionSeparator()

Adds a separator allowing the cojoining of multiple permission updates into a single packet.

After this method is invoked, the user should invoke the addKeyField method.

addPermissionSeperator

void addPermissionSeperator()

Deprecated.

Adds a seperator allowing the cojoining of multiple permission updates into a single packet.

After this method is invoked, the user should invoke the addKeyField method.