From fa5a20b936108280814111dc3d39c8b47c65dd8d Mon Sep 17 00:00:00 2001
From: Thomas Lenz <thomas.lenz@egiz.gv.at>
Date: Tue, 18 Feb 2020 08:06:05 +0100
Subject: add JavaDoc
---
.../modules/pvp2/api/IPvp2BasicConfiguration.java | 63 ++++++++++++++++++++--
1 file changed, 59 insertions(+), 4 deletions(-)
(limited to 'eaaf_modules/eaaf_module_pvp2_core/src')
diff --git a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/api/IPvp2BasicConfiguration.java b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/api/IPvp2BasicConfiguration.java
index 08ff2d8e..5eaa49ca 100644
--- a/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/api/IPvp2BasicConfiguration.java
+++ b/eaaf_modules/eaaf_module_pvp2_core/src/main/java/at/gv/egiz/eaaf/modules/pvp2/api/IPvp2BasicConfiguration.java
@@ -21,23 +21,78 @@ package at.gv.egiz.eaaf.modules.pvp2.api;
import java.util.List;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
import at.gv.egiz.eaaf.core.exceptions.EaafException;
import org.opensaml.saml.saml2.metadata.ContactPerson;
import org.opensaml.saml.saml2.metadata.Organization;
+/**
+ * Basic SAML2 configuration object that provide information for SAML2 metadata.
+ *
+ * @author tlenz
+ *
+ */
public interface IPvp2BasicConfiguration {
- String getIdpEntityId(String authUrl) throws EaafException;
+ /**
+ * SAML2 EntityId.
+ *
+ * @param authUrl The Public-URL prefix of the application that always ends without /
+ * @return EntityId
+ * @throws EaafException In case of an error.
+ */
+ @Nonnull
+ String getIdpEntityId(@Nonnull String authUrl) throws EaafException;
- String getIdpSsoPostService(String authUrl) throws EaafException;
+ /**
+ * Authentication end-point for POST-Binding in case of an IDP.
+ *
+ * @param authUrl The Public-URL prefix of the application that always ends without /
+ * @return IDP SSO endpoint
+ * @throws EaafException In case of an error.
+ */
+ @Nullable
+ String getIdpSsoPostService(@Nonnull String authUrl) throws EaafException;
- String getIdpSsoRedirectService(String authUrl) throws EaafException;
+ /**
+ * Authentication end-point for POST-Redirect in case of an IDP.
+ *
+ * @param authUrl The Public-URL prefix of the application that always ends without /
+ * @return IDP SSO endpoint
+ * @throws EaafException In case of an error.
+ */
+ @Nullable
+ String getIdpSsoRedirectService(@Nonnull String authUrl) throws EaafException;
- Object getIdpSsoSoapService(String extractAuthUrlFromRequest) throws EaafException;
+ /**
+ * Authentication end-point for POST-SOAP in case of an IDP.
+ *
+ * @param authUrl The Public-URL prefix of the application that always ends without /
+ * @return IDP SSO endpoint
+ * @throws EaafException In case of an error.
+ */
+ @Nullable
+ String getIdpSsoSoapService(@Nonnull String extractAuthUrlFromRequest) throws EaafException;
+ /**
+ * Contact information for SAML2 Metadata.
+ *
+ * @return SAML2 Contact object
+ * @throws EaafException In case of an error.
+ */
+ @Nonnull
List<ContactPerson> getIdpContacts() throws EaafException;
+ /**
+ * Organization information for SAML2 Metadata.
+ *
+ * @return SAML2 Organization object
+ * @throws EaafException In case of an error.
+ */
+ @Nonnull
Organization getIdpOrganisation() throws EaafException;
}
--
cgit v1.2.3