org.zaproxy.zap.session.SessionManagementMethodType Maven / Gradle / Ivy
Show all versions of zap Show documentation
/*
* Zed Attack Proxy (ZAP) and its related class files.
*
* ZAP is an HTTP/HTTPS proxy for assessing web application security.
*
* Copyright 2013 The ZAP Development Team
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.zaproxy.zap.session;
import net.sf.json.JSONObject;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;
import org.parosproxy.paros.db.DatabaseException;
import org.parosproxy.paros.extension.ExtensionHook;
import org.parosproxy.paros.model.Session;
import org.zaproxy.zap.extension.api.ApiDynamicActionImplementor;
import org.zaproxy.zap.model.Context;
/**
* A type of session management method. This class also acts as a factory for creating {@link
* SessionManagementMethod} objects.
*
* The implementors of new Session Management Methods should also implement a corresponding type.
* The system automatically detects and loads {@link SessionManagementMethodType} classes and,
* through them, the corresponding session management methods.
*/
public abstract class SessionManagementMethodType {
/**
* Builds a new, empty, session management method. The session management method should then be
* configured through its corresponding Options panel.
*
* @param contextId the context id
* @return the session management method
* @see #buildOptionsPanel(Context)
*/
public abstract SessionManagementMethod createSessionManagementMethod(int contextId);
/**
* Gets the name of the session management method.
*
* @return the name
*/
public abstract String getName();
/**
* Gets the unique identifier of this Session Management Method Type. It has to be unique among
* all Session Management Method Types.
*
* @return the unique identifier
*/
public abstract int getUniqueIdentifier();
/**
* Builds the options panel that can be used to fully configure a session management method.
*
* @param uiSharedContext the ui shared context on which the panel should work
* @return the abstract session method options panel
* @see #hasOptionsPanel()
*/
public abstract AbstractSessionManagementMethodOptionsPanel buildOptionsPanel(
Context uiSharedContext);
/**
* Checks if the corresponding {@link SessionManagementMethod} has an options panel that can be
* used for configuration.
*
* @see #buildOptionsPanel(Context)
* @return true, if successful
*/
public abstract boolean hasOptionsPanel();
/**
* Checks if is this the type for the Session Management Method provided as parameter.
*
* @param method the method
* @return true, if is type for method
*/
public abstract boolean isTypeForMethod(SessionManagementMethod method);
@Override
public String toString() {
return getName();
}
/**
* Hooks the Session Management Method Type with other components of ZAP, if needed. This method
* will be called only once, when authentication types are loaded.
*
*
For example, PopupMenus can be registered.
*
* @param extensionHook the extension hook
*/
public abstract void hook(ExtensionHook extensionHook);
/**
* Loads a session management method from the Session. The implementation depends on the a
* session management method type.
*
* @param session the session
* @param contextId the context ID
* @return the session management method
* @throws DatabaseException if an error occurred while loading the authentication method
*/
public abstract SessionManagementMethod loadMethodFromSession(Session session, int contextId)
throws DatabaseException;
/**
* Persists the session management method to the session.
*
* @param session the session
* @param contextId the context id
* @param method the session management method to persist
* @throws UnsupportedSessionManagementMethodException the unsupported session management method
* exception
* @throws DatabaseException if an error occurred while persisting the authentication method
*/
public abstract void persistMethodToSession(
Session session, int contextId, SessionManagementMethod method)
throws DatabaseException;
/**
* Export the method to the configuration
*
* @param config the configurations where to export/save the session management method
* @param sessionMethod the session management method to be exported
*/
public abstract void exportData(Configuration config, SessionManagementMethod sessionMethod);
/**
* Import the method from the configuration
*
* @param config the configurations from where to import/load the session management method
* @param sessionMethod where to set the imported session management method data
* @throws ConfigurationException if an error occurred while reading the session management
* method data
*/
public abstract void importData(Configuration config, SessionManagementMethod sessionMethod)
throws ConfigurationException;
/** Thrown when an unsupported type of SessionManagement is used. */
public class UnsupportedSessionManagementMethodException extends RuntimeException {
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 4802501809913124766L;
public UnsupportedSessionManagementMethodException(String message) {
super(message);
}
}
/**
* Gets the {@link ApiDynamicActionImplementor} that can be used to set a session management
* method of this type for a context.
*
*
This api action will be handled by executing the {@link
* ApiDynamicActionImplementor#handleAction(JSONObject)} method.
*
* @return the api action, or null if there is no way to set this method type through the API
*/
public abstract ApiDynamicActionImplementor getSetMethodForContextApiAction();
}