summaryrefslogtreecommitdiff
path: root/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java
diff options
context:
space:
mode:
authorThomas <thomas.lenz@egiz.gv.at>2019-12-05 09:52:48 +0100
committerThomas <thomas.lenz@egiz.gv.at>2019-12-05 09:52:48 +0100
commit3fada6cef21c9b16467177d866df778203b51b4d (patch)
tree8fe8ed37b6ee9fe35a1e035ceba6c68808328415 /eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java
parent95b21a826e5d81fdeabcf4673a9e87047edaec9d (diff)
downloadEAAF-Components-3fada6cef21c9b16467177d866df778203b51b4d.tar.gz
EAAF-Components-3fada6cef21c9b16467177d866df778203b51b4d.tar.bz2
EAAF-Components-3fada6cef21c9b16467177d866df778203b51b4d.zip
some code code-style modifications
active code-quality checks!
Diffstat (limited to 'eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java')
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java80
1 files changed, 42 insertions, 38 deletions
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java
index fa8cb7f4..dd18d04f 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/IRequest.java
@@ -21,23 +21,26 @@ package at.gv.egiz.eaaf.core.api;
import java.io.Serializable;
import java.util.Map;
+
import javax.annotation.Nonnull;
-import at.gv.egiz.eaaf.core.api.idp.IspConfiguration;
+
+import at.gv.egiz.eaaf.core.api.idp.ISpConfiguration;
import at.gv.egiz.eaaf.core.exceptions.EaafStorageException;
public interface IRequest extends Serializable {
/**
- * Indicates the module, which implements this authentication protocol. The class, which is
- * referenced, had to implement the 'IModulInfo' interface.
+ * Indicates the module, which implements this authentication protocol. The
+ * class, which is referenced, had to implement the 'IModulInfo' interface.
*
* @return Full-qualified name of the class which implements this protocol
*/
String requestedModule();
/**
- * Indicates the protocol specific action, which should executed if the request is processed. The
- * class, which is referenced, had to implement the 'IAction' interface.
+ * Indicates the protocol specific action, which should executed if the request
+ * is processed. The class, which is referenced, had to implement the 'IAction'
+ * interface.
*
* @return Full-qualified name of the class which implements the action
*/
@@ -51,24 +54,27 @@ public interface IRequest extends Serializable {
String getSpEntityId();
/**
- * Indicates the passive flag in authentication requests. If the passive flag is set, the
- * identification and authentication process failed if no active SSO session is found.
+ * Indicates the passive flag in authentication requests. If the passive flag is
+ * set, the identification and authentication process failed if no active SSO
+ * session is found.
*
- * @return true, if the is passive flag is set in authentication request, otherwise false
+ * @return true, if the is passive flag is set in authentication request,
+ * otherwise false
*/
boolean isPassiv();
/**
- * Indicates the force authentication flag in authentication request If this flag is set, a new
- * identification and authentication process is carried out in any case.
+ * Indicates the force authentication flag in authentication request If this
+ * flag is set, a new identification and authentication process is carried out
+ * in any case.
*
* @return true, if the force authentication flag is set, otherwise false
*/
boolean forceAuth();
-
/**
- * Returns a generic request-data object with is stored with a specific identifier.
+ * Returns a generic request-data object with is stored with a specific
+ * identifier.
*
* @param key The specific identifier of the request-data object
* @return The request-data object or null if no data is found with this key
@@ -76,9 +82,10 @@ public interface IRequest extends Serializable {
Object getRawData(String key);
/**
- * Returns a generic request-data object with is stored with a specific identifier.
+ * Returns a generic request-data object with is stored with a specific
+ * identifier.
*
- * @param key The specific identifier of the request-data object
+ * @param key The specific identifier of the request-data object
* @param clazz The class type which is stored with this key
* @return The request-data object or null if no data is found with this key
*/
@@ -87,11 +94,11 @@ public interface IRequest extends Serializable {
/**
* Store a generic data-object into pending request with a specific identifier.
*
- * @param key Identifier for this data-object
- * @param object Generic data-object which should be stored. This data-object had to be implement
- * the 'java.io.Serializable' interface
- * @throws SessionDataStorageException Error message if the data-object can not stored to generic
- * request-data storage
+ * @param key Identifier for this data-object
+ * @param object Generic data-object which should be stored. This data-object
+ * had to be implement the 'java.io.Serializable' interface
+ * @throws SessionDataStorageException Error message if the data-object can not
+ * stored to generic request-data storage
*/
void setRawDataToTransaction(String key, Object object) throws EaafStorageException;
@@ -99,8 +106,8 @@ public interface IRequest extends Serializable {
* Store generic data-objects into pending request with specific identifiers.
*
* @param map Map with Identifiers and values
- * @throws SessionDataStorageException Error message if the data-object can not stored to generic
- * request-data storage
+ * @throws SessionDataStorageException Error message if the data-object can not
+ * stored to generic request-data storage
*/
void setRawDataToTransaction(Map<String, Object> map) throws EaafStorageException;
@@ -114,14 +121,13 @@ public interface IRequest extends Serializable {
<T> T getSessionData(@Nonnull Class<T> wrapper);
/**
- * Hold the identifier of this request object. This identifier can be used to load the request
- * from request storage.
+ * Hold the identifier of this request object. This identifier can be used to
+ * load the request from request storage.
*
* @return Request identifier
*/
String getPendingRequestId();
-
/**
* Hold the identifier of the SSO-Session which is associated with this request.
*
@@ -137,31 +143,31 @@ public interface IRequest extends Serializable {
void setInternalSsoSessionIdentifier(String internalSsoSessionId);
/**
- * Holds a unique transaction identifier, which could be used for looging This transaction
- * identifier is unique for a single identification and authentication process.
+ * Holds a unique transaction identifier, which could be used for looging This
+ * transaction identifier is unique for a single identification and
+ * authentication process.
*
* @return Unique transaction identifier.
*/
String getUniqueTransactionIdentifier();
/**
- * Holds a unique session identifier, which could be used for logging This session identifier is
- * unique for the full Single Sign-On session time.
+ * Holds a unique session identifier, which could be used for logging This
+ * session identifier is unique for the full Single Sign-On session time.
*
* @return Unique session identifier
*/
String getUniqueSessionIdentifier();
-
/**
- * Hold the identifier if the process instance, which is associated with this request.
+ * Hold the identifier if the process instance, which is associated with this
+ * request.
*
- * @return ProcessInstanceID if this request is associated with a authentication process,
- * otherwise null
+ * @return ProcessInstanceID if this request is associated with a authentication
+ * process, otherwise null
*/
String getProcessInstanceId();
-
/**
* get the IDP URL PreFix, which was used for authentication request.
*
@@ -197,7 +203,6 @@ public interface IRequest extends Serializable {
*/
void setNeedSingleSignOnFunctionality(boolean needSso);
-
/**
* Indicates, if this pending request needs an additional user consent.
*
@@ -221,8 +226,7 @@ public interface IRequest extends Serializable {
*
* @return Service-Provider configuration
*/
- IspConfiguration getServiceProviderConfiguration();
-
+ ISpConfiguration getServiceProviderConfiguration();
/**
* Get get Service-Provider configuration which is associated with this request.
@@ -231,7 +235,6 @@ public interface IRequest extends Serializable {
*/
<T> T getServiceProviderConfiguration(final Class<T> decorator);
-
/**
* Indicates, if this pending-request is aborted by the user.
*
@@ -242,7 +245,8 @@ public interface IRequest extends Serializable {
/**
* Set the 'isAboredByUser' flag of this pending-request.
*
- * @param isAborted true, if the user has abort the authentication process, otherwise false
+ * @param isAborted true, if the user has abort the authentication process,
+ * otherwise false
*/
void setAbortedByUser(boolean isAborted);