Package org.zaproxy.zap.model

Interface ContextDataFactory

All Known Implementing Classes:

ExtensionAuthentication, ExtensionAuthorization, ExtensionForcedUser, ExtensionSessionManagement, ExtensionUserManagement

public interface ContextDataFactory

A Context Data Factory implements the logic for persisting and loading data into Contexts into/from a Session, for external (non-core) components.

Method Summary

Modifier and Type	Method	Description
void	exportContextData(Context ctx, org.apache.commons.configuration.Configuration config)	Export the Context data into the given configuration
void	importContextData(Context ctx, org.apache.commons.configuration.Configuration config)	Import the Context data from the given configuration
void	loadContextData(Session session, Context context)	Loads the Context data from the given session.
void	persistContextData(Session session, Context context)	Save the Context data into the given session.

Method Detail

loadContextData

void loadContextData(Session session,
                     Context context)

Loads the Context data from the given session.

Parameters:

session - the session to load from, not null.

context - the context to load into, not null.

persistContextData

void persistContextData(Session session,
                        Context context)

Save the Context data into the given session.

Parameters:

session - the session to persist into, not null.

context - the context to persist from, not null.

exportContextData

void exportContextData(Context ctx,
                       org.apache.commons.configuration.Configuration config)

Export the Context data into the given configuration

Parameters:

ctx - the context to export, not null.

config - the Configuration where to export the context data, not null.

importContextData

void importContextData(Context ctx,
                       org.apache.commons.configuration.Configuration config)
                throws org.apache.commons.configuration.ConfigurationException

Import the Context data from the given configuration

Parameters:

ctx - the context to import the context data to

config - the Configuration containing the context data, not null.

Throws:

org.apache.commons.configuration.ConfigurationException - if an error occurred while reading the context data from the Configuration, not null.