org.kitteh.irc.client.library.feature.sts

Interface StsMachine

All Known Implementing Classes:

MemoryStsMachine

public interface StsMachine

Interface representing the STS FSM.

This is a finite state machine which represents the various states related to strict-transport security that the client can be in at any one time.

State changes are caused by the IRCd sending the appropriate capability data, or if a user manually initiates a change. Actions are automatically taken as a result of state transitions,

Method Summary

Modifier and Type	Method and Description
@NonNull StsClientState	getCurrentState() Returns the current state in the enum that the state machine is operating in.
@NonNull StsStorageManager	getStorageManager() Gets the persistence/storage manager.
void	setCurrentState(@NonNull StsClientState newState) Changes the state of the FSM, triggering any state-specific work.
void	setStsPolicy(@NonNull StsPolicy policy) Provides a key->value map of options and list of flags, making up the STS policy.

Method Detail

getCurrentState

@NonNull StsClientState getCurrentState()

Returns the current state in the enum that the state machine is operating in.

Returns:

one of STSClientState's members

setCurrentState

void setCurrentState(@NonNull StsClientState newState)

Changes the state of the FSM, triggering any state-specific work.

Parameters:

newState - a valid (non-UNKNOWN, non-null) state

getStorageManager

@NonNull StsStorageManager getStorageManager()

Gets the persistence/storage manager.

Returns:

the storage manager instance

setStsPolicy

void setStsPolicy(@NonNull StsPolicy policy)

Provides a key->value map of options and list of flags, making up the STS policy.

It is expected the policy is valid at this stage.

Parameters:

policy - the valid STS policy