com.preemptive.annotation.instrumentation

Annotation Type ShelfLifeCheck

@Retention(value=CLASS)
 @Target(value={CONSTRUCTOR,METHOD})
public @interface ShelfLifeCheck

Perform a Shelf Life expiration check.

Performs a Shelf Life check using the expiration parameters. The expiration can be defined by using one of these techniques:

• Absolute expiration: The expiration of the application is set to a fixed point in time with the expirationDate attribute. The warningDate attribute specifies when warnings about expiration will be emitted. This is optional, and if omitted then no warnings are given.
• Relative expiration: The application is set to expire a specified number of days after a dynamic start date with the expirationPeriod attribute. The start date is retrieved from a field or method specified with the startDateSource attribute. This field of type or method returning a java.util.Date. Similarly, the warning date is specified as a number of days prior to the expiration date with the warningPeriod attribute.
• Externally managed: The Shelf Life token is managed independently from the compiled application, generated either through the PreEmptive Protection - DashO UI or via the tokengenerator command-line utility. The tokenSource attribute specifies a field of type or method returning a java.io.Reader that reads the token (as from a file). If the expiration stored in the token is relative then the start date must also be provided. If this approach is used, values set for expiration/warning date/period in the annotation are ignored.

The Shelf Life check performs one of the following actions:

• Default action: If a custom action is omitted the default actions are taken. If the application is in the warning period, a message is emitted to System.out (or a dialog). If the application has expired, then a message is emitted to System.out (or a dialog) and System.exit() is called with a exit code of 1. On Android, if injected into an Activity it will finish() that activity, otherwise it will throw an exception.
• Custom action: The check can be provided with a custom action by setting the action attribute. The method is called each time a check is made, and the result of the check can be determined by interrogating the passed token. The method must accept a token and return void:
  
  void someCustomActionMethod(Token token)

A Shelf Life key file is necessary when creating Shelf Life tokens, whether that is at build-time if the token is integrated into the compiled application or at token-creation-time if the token is managed externally. The location of the Shelf Life key file can be specified in the <shelflife> section of the configuration file, or on the Shelf Life Check screen.

See Also:

Specifying Sources and Actions

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	action The custom action method that will be called on each check.
java.lang.String	expirationDate The expiration date.
java.lang.String	expirationPeriod The number of days since the start date that the application expires.
java.lang.String	startDateSource The source for the start date when using relative expiration period.
java.lang.String	tokenSource The source for the expiration token when providing a token at run-time.
java.lang.String	warningDate The warning date.
java.lang.String	warningPeriod The number of days before expiration that the warning period starts.
InjectionPoint	where The location in the method where instrumentation will take place.

Element Detail

action

public abstract java.lang.String action

The custom action method that will be called on each check. If blank the default actions take place. Only method actions are supported. The method must take a Token instance.

See Also:

Specifying Sources and Actions

Default:

""

where

public abstract InjectionPoint where

The location in the method where instrumentation will take place.

Default:

com.preemptive.annotation.instrumentation.InjectionPoint.Beginning

expirationDate

public abstract java.lang.String expirationDate

The expiration date. The date must be in MM/DD/YYYY format. May reference DashO properties, which will be expanded at the time of instrumentation.

Default:

""

warningDate

public abstract java.lang.String warningDate

The warning date. The date must be in MM/DD/YYYY format. May reference DashO properties, which will be expanded at the time of instrumentation.

Default:

""

startDateSource

public abstract java.lang.String startDateSource

The source for the start date when using relative expiration period. The value is the name of a Date field or a zero-argument method returning Date.

See Also:

Specifying Sources andActions

Default:

""

expirationPeriod

public abstract java.lang.String expirationPeriod

The number of days since the start date that the application expires. The value must be greater than zero. May reference DashO properties, which will be expanded at the time of instrumentation.

Default:

""

warningPeriod

public abstract java.lang.String warningPeriod

The number of days before expiration that the warning period starts. The value must be greater than zero. May reference DashO properties, which will be expanded at the time of instrumentation.

Default:

""

tokenSource

public abstract java.lang.String tokenSource

The source for the expiration token when providing a token at run-time. The value is the name of a Reader field or a zero-argument method returning the Reader. The Reader's close() method will be called automatically.

See Also:

Specifying Sources and Action.

Default:

""