org.eclipse.kura.security.tamper.detection

Interface TamperDetectionService

@ProviderType
public interface TamperDetectionService

Specifies a service that implements tamper detection features. This service introduces the concept of tamper status. The definition of tamper status depends on the implementation, for example a device might be considered to be tampered if its external enclosure has been opened. The tamper status is represented by the TamperStatus class. The tamper status can be reset by calling the resetTamperStatus() method. This service must also generate TamperEvent EventAdmin events in particular conditions, see the corresponding Javadoc for more details.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Returns an user friendly name describing this service.
TamperStatus	getTamperStatus() Returns the current TamperStatus.
void	resetTamperStatus() Allows to reset the tamper state.

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns an user friendly name describing this service.

Returns:

an user friendly name describing this service.

getTamperStatus

TamperStatus getTamperStatus()
                      throws KuraException

Returns the current TamperStatus.

Returns:

the current TamperStatus.

Throws:

KuraException - in case of an implementation failure in determining the tamper status.

resetTamperStatus

void resetTamperStatus()
                throws KuraException

Allows to reset the tamper state. After this method returns, the result of calling getTamperStatus() should have the tamper flag set to false, until the next tamper event is detected.

Throws:

KuraException - in case of reset implementation failure.