org.gcube.accounting.datamodel

Class BasicUsageRecord

java.lang.Object

org.gcube.accounting.datamodel.BasicUsageRecord

All Implemented Interfaces:

Serializable, Comparable<UsageRecord>, UsageRecord

Direct Known Subclasses:

AbstractJobUsageRecord, AbstractPortletUsageRecord, AbstractServiceUsageRecord, AbstractStorageUsageRecord, AbstractTaskUsageRecord, RawUsageRecord

public abstract class BasicUsageRecord
extends Object
implements UsageRecord, Serializable

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.gcube.accounting.datamodel.UsageRecord

UsageRecord.OperationResult

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AGGREGATED Internal USE ONLY.
protected Set<String>	aggregatedFields
protected Set<String>	computedFields
static String	CONSUMER_ID KEY for : The user (or the Consumer Identity, that in the S2S communication is another service).
static String	CREATION_TIME KEY for : The instant when the UR was created.
protected static String	END_TIME KEY for : Used in aggregated record.
protected static String	ID KEY for : The unique identifier for the UsageRecord.
protected static String	OPERATION_COUNT KEY for : Indicate The Number of Aggregated Operation
static String	OPERATION_RESULT KEY for : The Operation Result of the accounted operation.
protected Set<String>	requiredFields
protected Map<String,Serializable>	resourceProperties resource-specific properties
static String	SCOPE KEY for : The accounting scope
protected static String	START_TIME KEY for : Used in aggregated record.
protected static String	USAGE_RECORD_TYPE Internal USE ONLY.
protected Map<String,List<FieldAction>>	validation

Constructor Summary

Constructors

Constructor and Description
BasicUsageRecord()
BasicUsageRecord(Map<String,Serializable> properties)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(UsageRecord usageRecord) Compare this UsageRecord instance with the one provided as argument
protected static Set<Field>	getAllFields(Class<?> type)
protected static Class<? extends UsageRecord>	getClass(String usageRecordName, boolean aggregated)
String	getConsumerId() Return the user (or the Consumer Identity, that in the S2S communication is another service)
Calendar	getCreationTime() Return the instant when this {#UsageRecord} was created.
protected Calendar	getEndTimeAsCalendar() Return the right end of the time interval covered by this {#UsageRecord}
protected long	getEndTimeInMillis() Return the right end of the time interval covered by this {#UsageRecord}
String	getId() Return the unique id for this {#UsageRecord}
protected static Map<String,Serializable>	getMapFromString(String serializedMap)
protected int	getOperationCount()
UsageRecord.OperationResult	getOperationResult()
Set<String>	getRequiredFields()
Map<String,Serializable>	getResourceProperties() Return all resource-specific properties.
Serializable	getResourceProperty(String key) Return the value of the given resource property.
String	getScope() Return the scope of this {#UsageRecord}
protected Calendar	getStartTimeAsCalendar() Return the left end of the time interval covered by this {#UsageRecord}
protected long	getStartTimeInMillis() Return the left end of the time interval covered by this {#UsageRecord}
static UsageRecord	getUsageRecord(Map<String,Serializable> usageRecordMap) This method use the resourceType value contained in the Map to instance the right UsageRecord class and return it.
static UsageRecord	getUsageRecord(String serializedMap)
String	getUsageRecordType() Return the Usage Record Type
protected abstract String	giveMeUsageRecordType()
protected void	initializeValidation()
void	setConsumerId(String consumerId) Set the user (or the Consumer Identity, that in the S2S communication is another service)
void	setCreationTime(Calendar creationTime) The CreationTime is automatically created by the implementation Class.
protected void	setEndTime(Calendar endTime) Set the right end of the time interval covered by this {#UsageRecord}
void	setId(String id) The ID is automatically Created by the implementation Class.
protected void	setOperationCount(int operationCount)
void	setOperationResult(UsageRecord.OperationResult operationResult) Set the Operation Result related to the accounted Usage Record
void	setResourceProperties(Map<String,Serializable> properties) Set all resource-specific properties, replacing existing ones
void	setResourceProperty(String key, Serializable value) Set the value of the given resource property.
void	setScope(String scope) Set the accounting scope of the {#UsageRecord}
protected void	setStartTime(Calendar startTime) Set the left end of the time interval covered by this {#UsageRecord}
protected void	setUsageRecordType()
protected Calendar	timestampStringToCalendar(long millis)
String	toString()
void	validate() Validate the Resource Record.
protected Serializable	validateField(String key, Serializable serializable)
protected Map<String,Serializable>	validateProperties(Map<String,Serializable> properties)

Methods inherited from class java.lang.Object

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

Field Detail

ID

protected static final String ID

KEY for : The unique identifier for the UsageRecord. The ID is automatically Created. Set the ID only if you really know what you are going to do.

See Also:

Constant Field Values

CONSUMER_ID

public static final String CONSUMER_ID

KEY for : The user (or the Consumer Identity, that in the S2S communication is another service).

See Also:

Constant Field Values

CREATION_TIME

public static final String CREATION_TIME

KEY for : The instant when the UR was created. The value will be recorded in UTC milliseconds from the epoch.

See Also:

Constant Field Values

USAGE_RECORD_TYPE

protected static final String USAGE_RECORD_TYPE

Internal USE ONLY. KEY for : The Class Name of the represented {#Usage Record}

See Also:

Constant Field Values

SCOPE

public static final String SCOPE

KEY for : The accounting scope

See Also:

Constant Field Values

OPERATION_RESULT

public static final String OPERATION_RESULT

KEY for : The Operation Result of the accounted operation. The value is expressed as #org.gcube.accounting.datamodel.UsageRecord.OperationResult

See Also:

Constant Field Values

resourceProperties

protected Map<String,Serializable> resourceProperties

resource-specific properties

validation

protected Map<String,List<FieldAction>> validation

requiredFields

protected Set<String> requiredFields

computedFields

protected Set<String> computedFields

START_TIME

protected static final String START_TIME

KEY for : Used in aggregated record. Represent the left end of the time interval covered by this {#Usage Record} The value will be recorded in UTC milliseconds from the epoch.

See Also:

Constant Field Values

END_TIME

protected static final String END_TIME

KEY for : Used in aggregated record. Represent the right end of the time interval covered by this {#Usage Record} The value will be recorded in UTC milliseconds from the epoch.

See Also:

Constant Field Values

AGGREGATED

protected static final String AGGREGATED

Internal USE ONLY. KEY for : Indicate that the record is an aggregation

See Also:

Constant Field Values

OPERATION_COUNT

protected static final String OPERATION_COUNT

KEY for : Indicate The Number of Aggregated Operation

See Also:

Constant Field Values

aggregatedFields

protected Set<String> aggregatedFields

Constructor Detail

BasicUsageRecord

public BasicUsageRecord()

BasicUsageRecord

public BasicUsageRecord(Map<String,Serializable> properties)
                 throws InvalidValueException

Throws:

InvalidValueException

Method Detail

getRequiredFields

public Set<String> getRequiredFields()

Specified by:

getRequiredFields in interface UsageRecord

Returns:

a Set containing the keys of required fields

getAllFields

protected static Set<Field> getAllFields(Class<?> type)

initializeValidation

protected void initializeValidation()

getUsageRecordType

public String getUsageRecordType()

Return the Usage Record Type

Specified by:

getUsageRecordType in interface UsageRecord

Returns:

{#UsageRecord} Type

giveMeUsageRecordType

protected abstract String giveMeUsageRecordType()

setUsageRecordType

protected void setUsageRecordType()

getId

public String getId()

Return the unique id for this {#UsageRecord}

Specified by:

getId in interface UsageRecord

Returns:

{#UsageRecord} Unique ID

setId

public void setId(String id)
           throws InvalidValueException

The ID is automatically Created by the implementation Class. Set the ID only if you really know what you are going to do. Set the unique id for this {#UsageRecord}

Specified by:

setId in interface UsageRecord

Parameters:

id - {#UsageRecord} Unique ID

Throws:

InvalidValueException

getConsumerId

public String getConsumerId()

Return the user (or the Consumer Identity, that in the S2S communication is another service)

Specified by:

getConsumerId in interface UsageRecord

Returns:

Consumer ID

setConsumerId

public void setConsumerId(String consumerId)
                   throws InvalidValueException

Set the user (or the Consumer Identity, that in the S2S communication is another service)

Specified by:

setConsumerId in interface UsageRecord

Parameters:

consumerId - Consumer ID

Throws:

InvalidValueException

timestampStringToCalendar

protected Calendar timestampStringToCalendar(long millis)

getCreationTime

public Calendar getCreationTime()

Return the instant when this {#UsageRecord} was created.

Specified by:

getCreationTime in interface UsageRecord

Returns:

the creation time for this {#UsageRecord}

setCreationTime

public void setCreationTime(Calendar creationTime)
                     throws InvalidValueException

The CreationTime is automatically created by the implementation Class. Set the CreationTime only if you really know what you are going to do. Set the instant when this {#UsageRecord} was created.

Specified by:

setCreationTime in interface UsageRecord

Parameters:

creationTime - creation time

Throws:

InvalidValueException

getScope

public String getScope()

Return the scope of this {#UsageRecord}

Specified by:

getScope in interface UsageRecord

Returns:

The scope of this {#UsageRecord}

setScope

public void setScope(String scope)
              throws InvalidValueException

Set the accounting scope of the {#UsageRecord}

Specified by:

setScope in interface UsageRecord

Parameters:

scope - The accounting scope of the {#UsageRecord}

Throws:

InvalidValueException

getResourceProperties

public Map<String,Serializable> getResourceProperties()

Return all resource-specific properties. The returned Map is a copy of the internal representation. Any modification to the returned Map MUST not affect the object

Specified by:

getResourceProperties in interface UsageRecord

Returns:

a Map containing the properties

setResourceProperties

public void setResourceProperties(Map<String,Serializable> properties)
                           throws InvalidValueException

Set all resource-specific properties, replacing existing ones

Specified by:

setResourceProperties in interface UsageRecord

Throws:

InvalidValueException

getResourceProperty

public Serializable getResourceProperty(String key)

Return the value of the given resource property.

Specified by:

getResourceProperty in interface UsageRecord

Parameters:

key - the key of the requested property

Returns:

the value of the given resource property

setResourceProperty

public void setResourceProperty(String key,
                       Serializable value)
                         throws InvalidValueException

Set the value of the given resource property. If the key has the value of one of the predefined property, the value is validated.

Specified by:

setResourceProperty in interface UsageRecord

Parameters:

key - the key of the requested property

value - the value of the given resource property

Throws:

InvalidValueException

getStartTimeInMillis

protected long getStartTimeInMillis()

Return the left end of the time interval covered by this {#UsageRecord}

Returns:

Start Time

getStartTimeAsCalendar

protected Calendar getStartTimeAsCalendar()

Return the left end of the time interval covered by this {#UsageRecord}

Returns:

Start Time

setStartTime

protected void setStartTime(Calendar startTime)
                     throws InvalidValueException

Set the left end of the time interval covered by this {#UsageRecord}

Parameters:

startTime - Start Time

Throws:

InvalidValueException

getEndTimeInMillis

protected long getEndTimeInMillis()

Return the right end of the time interval covered by this {#UsageRecord}

Returns:

End Time

getEndTimeAsCalendar

protected Calendar getEndTimeAsCalendar()

Return the right end of the time interval covered by this {#UsageRecord}

Returns:

End Time

setEndTime

protected void setEndTime(Calendar endTime)
                   throws InvalidValueException

Set the right end of the time interval covered by this {#UsageRecord}

Parameters:

endTime - End Time

Throws:

InvalidValueException

getOperationCount

protected int getOperationCount()

setOperationCount

protected void setOperationCount(int operationCount)
                          throws InvalidValueException

Throws:

InvalidValueException

validateField

protected Serializable validateField(String key,
                         Serializable serializable)
                              throws InvalidValueException

Throws:

InvalidValueException

validateProperties

protected Map<String,Serializable> validateProperties(Map<String,Serializable> properties)
                                               throws InvalidValueException

Throws:

InvalidValueException

validate

public void validate()
              throws InvalidValueException

Validate the Resource Record. The validation check if all the Required Field are set and has valid value.

Specified by:

validate in interface UsageRecord

Throws:

InvalidValueException

toString

public String toString()

Overrides:

toString in class Object

getOperationResult

public UsageRecord.OperationResult getOperationResult()

Specified by:

getOperationResult in interface UsageRecord

Returns:

the Operation Result of the accounted operation.

setOperationResult

public void setOperationResult(UsageRecord.OperationResult operationResult)
                        throws InvalidValueException

Set the Operation Result related to the accounted Usage Record

Specified by:

setOperationResult in interface UsageRecord

Parameters:

operationResult - the Operation Result to set

Throws:

InvalidValueException

compareTo

public int compareTo(UsageRecord usageRecord)

Compare this UsageRecord instance with the one provided as argument

Specified by:

compareTo in interface Comparable<UsageRecord>

Parameters:

usageRecord - the Usage Record to compare

Returns:

0 is and only if the UsageRecord provided as parameter contains all and ONLY the parameters contained in this instance. If the number of parameters differs, the methods return the difference between the number of parameter in this instance and the ones in the UsageRecord provided as parameter. If the size is the same but the UsageRecord provided as parameter does not contains all parameters in this instance, -1 is returned.

getClass

protected static Class<? extends UsageRecord> getClass(String usageRecordName,
                                    boolean aggregated)
                                                throws ClassNotFoundException

Throws:

ClassNotFoundException

getUsageRecord

public static UsageRecord getUsageRecord(Map<String,Serializable> usageRecordMap)
                                  throws Exception

This method use the resourceType value contained in the Map to instance the right UsageRecord class and return it. If the type implementation does not exist or the validation of one or more field validation fails an exception is thrown

Parameters:

usageRecordMap -

Returns:

the instance of the UsageRecord class.

Throws:

Exception - if fails

getMapFromString

protected static Map<String,Serializable> getMapFromString(String serializedMap)

getUsageRecord

public static UsageRecord getUsageRecord(String serializedMap)
                                  throws Exception

Parameters:

serializedMap -

Returns:

Throws:

Exception