aboutsummaryrefslogtreecommitdiff
path: root/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java
diff options
context:
space:
mode:
Diffstat (limited to 'id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java')
-rw-r--r--id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java23
1 files changed, 12 insertions, 11 deletions
diff --git a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java
index 6c9981feb..295a51a24 100644
--- a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java
+++ b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/moduls/moduleregistration/AuthModule.java
@@ -9,31 +9,32 @@ import at.gv.egovernment.moa.id.process.model.ProcessDefinition;
public interface AuthModule {
/**
- * Returns the priority of the module. The priority defines the place in the
- * order of modules. The module with a highest priority is asked first, if
- * it has a process which can do an authentication.
+ * Returns the priority of the module. The priority defines the order of the respective module within the chain of
+ * discovered modules. Higher priorized modules are asked before lower priorized modules for a process that they can
+ * handle.
+ * <p/>
+ * Internal default modules are priorized neutral ({@code 0}. Use a higher priority ({@code 1...Integer.MAX_VALUE})
+ * in order to have your module(s) priorized or a lower priority ({@code Integer.MIN_VALUE...-1}) in order to put
+ * your modules behind default modules.
*
* @return the priority of the module.
*/
int getPriority();
/**
- * Checks if the module has a process, which is able to perform an authentication
- * with the given {@link ExecutionContext}.
+ * Checks if the module has a process, which is able to perform an authentication with the given
+ * {@link ExecutionContext}.
*
* @param context
* an ExecutionContext for a process.
- * @return the process-ID of a process which is able to work with the given
- * ExecutionContext, or {@code null}.
+ * @return the process-ID of a process which is able to work with the given ExecutionContext, or {@code null}.
*/
String selectProcess(ExecutionContext context);
/**
- * Returns the an Array of {@link ProcessDefinition}s of the processes
- * included in this module.
+ * Returns the an Array of {@link ProcessDefinition}s of the processes included in this module.
*
- * @return an array of resource uris of the processes included in this
- * module.
+ * @return an array of resource uris of the processes included in this module.
*/
String[] getProcessDefinitions();