[java-identity-provider] branch master updated: Javadoc fixes for CAS protocol components.
Marvin S. Addison
marvin.addison at gmail.com
Wed Nov 28 11:46:38 EST 2018
This is an automated email from the git hooks/post-receive script.
serac pushed a commit to branch master
in repository java-identity-provider.
View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=384455151689810fe3509fb3350a3f692b32a7d6
The following commit(s) were added to refs/heads/master by this push:
new 3844551 Javadoc fixes for CAS protocol components.
3844551 is described below
commit 384455151689810fe3509fb3350a3f692b32a7d6
Author: Marvin S. Addison <serac at vt.edu>
AuthorDate: Wed Nov 28 11:42:52 2018 -0500
Javadoc fixes for CAS protocol components.
---
.../net/shibboleth/idp/cas/ticket/ProxyGrantingTicket.java | 7 ++++---
.../main/java/net/shibboleth/idp/cas/ticket/ProxyTicket.java | 7 ++++---
.../java/net/shibboleth/idp/cas/ticket/ServiceTicket.java | 7 ++++---
.../src/main/java/net/shibboleth/idp/cas/ticket/Ticket.java | 11 ++++++++---
.../idp/cas/service/impl/MetadataServiceRegistry.java | 4 ++--
5 files changed, 22 insertions(+), 14 deletions(-)
diff --git a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyGrantingTicket.java b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyGrantingTicket.java
index 95718de..3f61cc1 100644
--- a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyGrantingTicket.java
+++ b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyGrantingTicket.java
@@ -38,14 +38,15 @@ public class ProxyGrantingTicket extends Ticket {
private String parentPgTicketId;
/**
- * Deprecated. Session IDs are now optional and should be specified via {@link TicketState#setSessionId(String)}
- * and {@link #setTicketState(TicketState)}.
+ * Deprecated.
*
* @param id Ticket ID.
- * @param sessionId IdP session ID used to create ticket.
+ * @param sessionId This parameter is ignored.
* @param service Service that requested the ticket.
* @param expiration Expiration instant.
* @param parentId ID of parent proxy-granting ticket or null if this is first proxy in chain.
+ *
+ * @see Ticket#Ticket(String, String, String, Instant)
*/
@Deprecated
public ProxyGrantingTicket(
diff --git a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyTicket.java b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyTicket.java
index 2c46229..a3e1315 100644
--- a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyTicket.java
+++ b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ProxyTicket.java
@@ -38,14 +38,15 @@ public class ProxyTicket extends Ticket {
private final String pgTicketId;
/**
- * Deprecated. Session IDs are now optional and should be specified via {@link TicketState#setSessionId(String)}
- * and {@link #setTicketState(TicketState)}.
+ * Deprecated.
*
* @param id Ticket ID.
- * @param sessionId IdP session ID used to create ticket.
+ * @param sessionId This parameter is ignored.
* @param service Service that requested the ticket.
* @param expiration Expiration instant.
* @param pgtId Proxy-granting ticket ID used to create ticket.
+ *
+ * @see Ticket#Ticket(String, String, String, Instant)
*/
@Deprecated
public ProxyTicket(
diff --git a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ServiceTicket.java b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ServiceTicket.java
index 1a66ca1..9c91ecc 100644
--- a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ServiceTicket.java
+++ b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/ServiceTicket.java
@@ -36,14 +36,15 @@ public class ServiceTicket extends Ticket {
private final boolean forceAuthn;
/**
- * Deprecated. Session IDs are now optional and should be specified via {@link TicketState#setSessionId(String)}
- * and {@link #setTicketState(TicketState)}.
+ * Deprecated.
*
* @param id Ticket ID.
- * @param sessionId IdP session ID used to create ticket.
+ * @param sessionId This parameter is ignored.
* @param service Service that requested the ticket.
* @param expiration Expiration instant.
* @param renew True if ticket was issued from forced authentication, false otherwise.
+ *
+ * @see Ticket#Ticket(String, String, String, Instant)
*/
@Deprecated
public ServiceTicket(
diff --git a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/Ticket.java b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/Ticket.java
index f3ba743..9e7966d 100644
--- a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/Ticket.java
+++ b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/Ticket.java
@@ -51,11 +51,16 @@ public class Ticket {
private TicketState ticketState;
/**
- * Deprecated. Session IDs are now optional and should be specified via {@link TicketState#setSessionId(String)}
- * and {@link #setTicketState(TicketState)}.
+ * Deprecated. This constructor was formerly used to associate a ticket with an IdP session, but is no longer
+ * supported. In order to associate an IdP session with a ticket, follow these steps:
+ * <ol>
+ * <li>Create a ticket using the {@link Ticket#Ticket(String, String, Instant)} constructor.</li>
+ * <li>Create an instance of {@link TicketState}, which accepts an IdP session ID parameter.</li>
+ * <li>Call {@link #setTicketState(TicketState)} on the ticket instance.</li>
+ * </ol>
*
* @param id Ticket ID.
- * @param sessionId IdP session ID used to create ticket.
+ * @param sessionId This parameter is ignored.
* @param service Service that requested the ticket.
* @param expiration Expiration instant.
*/
diff --git a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/service/impl/MetadataServiceRegistry.java b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/service/impl/MetadataServiceRegistry.java
index c8ff826..fb2cdc2 100644
--- a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/service/impl/MetadataServiceRegistry.java
+++ b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/service/impl/MetadataServiceRegistry.java
@@ -54,8 +54,8 @@ import org.slf4j.LoggerFactory;
* following criteria:
*
* <ol>
- * <li>Defines <code>{@value AbstractProtocolConfiguration#PROTOCOL_URI}</code> in the
- * <code>protocolSupportEnumeration</code> attribute of an <code>SPSSODescriptor</code> element.</li>
+ * <li>Defines <code>https://www.apereo.org/cas/protocol</code> in the <code>protocolSupportEnumeration</code>
+ * attribute of an <code>SPSSODescriptor</code> element.</li>
* <li>Defines an <code>AssertionConsumerService</code> element where the <code>Binding</code> URI is
* {@value #LOGIN_BINDING}.</li>
* <li>Matching <code>AssertionConsumerService</code> element also defines a <code>Location</code> attribute
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list