[java-identity-provider] branch master updated: Javadoc fixes.
Scott Cantor
cantor.2 at osu.edu
Tue Mar 19 11:40:08 EDT 2019
This is an automated email from the git hooks/post-receive script.
scantor 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=7505aff9b2af0e6d6529b6d382c54bc28d8132dd
The following commit(s) were added to refs/heads/master by this push:
new 7505aff Javadoc fixes.
7505aff is described below
commit 7505aff9b2af0e6d6529b6d382c54bc28d8132dd
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Tue Mar 19 11:40:04 2019 -0400
Javadoc fixes.
---
.../idp/authn/context/AuthenticationContext.java | 2 +-
.../idp/profile/RequestContextBuilder.java | 21 +++++++++++----------
.../shibboleth/idp/saml/session/SAML1SPSession.java | 4 ++--
.../shibboleth/idp/saml/session/SAML2SPSession.java | 4 ++--
.../BaseIdPInitiatedSSORequestMessageDecoder.java | 2 +-
.../saml/profile/impl/IdPInitiatedSSORequest.java | 8 ++++----
.../impl/SAML1SPSessionCreationStrategy.java | 2 +-
.../saml/session/impl/SAML1SPSessionSerializer.java | 2 +-
.../impl/SAML2SPSessionCreationStrategy.java | 3 +--
.../saml/session/impl/SAML2SPSessionSerializer.java | 2 +-
.../shibboleth/idp/session/AbstractIdPSession.java | 14 +++++++-------
.../idp/session/AbstractSPSessionSerializer.java | 4 ++--
.../net/shibboleth/idp/session/BasicSPSession.java | 8 ++++----
.../java/net/shibboleth/idp/session/IdPSession.java | 8 ++++----
.../java/net/shibboleth/idp/session/SPSession.java | 8 ++++----
.../impl/BasicSPSessionCreationStrategy.java | 2 +-
.../idp/session/impl/BasicSPSessionSerializer.java | 2 +-
.../idp/session/impl/StorageBackedIdPSession.java | 2 +-
18 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java
index 7bc299d..9ebabc2 100644
--- a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java
+++ b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/context/AuthenticationContext.java
@@ -131,7 +131,7 @@ public final class AuthenticationContext extends BaseContext {
}
/**
- * Get the time, in milliseconds since the epoch, when the authentication process started.
+ * Get the time when the authentication process started.
*
* @return time when the authentication process started
*/
diff --git a/idp-profile-api/src/test/java/net/shibboleth/idp/profile/RequestContextBuilder.java b/idp-profile-api/src/test/java/net/shibboleth/idp/profile/RequestContextBuilder.java
index f144579..0bc8d14 100644
--- a/idp-profile-api/src/test/java/net/shibboleth/idp/profile/RequestContextBuilder.java
+++ b/idp-profile-api/src/test/java/net/shibboleth/idp/profile/RequestContextBuilder.java
@@ -17,6 +17,7 @@
package net.shibboleth.idp.profile;
+import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
@@ -68,8 +69,8 @@ public class RequestContextBuilder {
/** The ID of the inbound message. */
private String inboundMessageId = NO_VAL;
- /** The issue instant of the inbound message in milliseconds. */
- private long inboundMessageIssueInstant;
+ /** The issue instant of the inbound message. */
+ private Instant inboundMessageIssueInstant;
/** The issuer of the inbound message. */
private String inboundMessageIssuer = NO_VAL;
@@ -80,8 +81,8 @@ public class RequestContextBuilder {
/** The ID of the outbound message. */
private String outboundMessageId = NO_VAL;
- /** The issue instant of the outbound message in milliseconds. */
- private long outboundMessageIssueInstant;
+ /** The issue instant of the outbound message. */
+ private Instant outboundMessageIssueInstant;
/** The issuer of the outbound message. */
private String outboundMessageIssuer = NO_VAL;
@@ -170,13 +171,13 @@ public class RequestContextBuilder {
}
/**
- * Sets the issue instant of the inbound message in milliseconds.
+ * Sets the issue instant of the inbound message
*
- * @param instant issue instant of the inbound message in milliseconds
+ * @param instant issue instant of the inbound message
*
* @return this builder
*/
- @Nonnull public RequestContextBuilder setInboundMessageIssueInstant(final long instant) {
+ @Nonnull public RequestContextBuilder setInboundMessageIssueInstant(@Nullable final Instant instant) {
inboundMessageIssueInstant = instant;
return this;
}
@@ -218,13 +219,13 @@ public class RequestContextBuilder {
}
/**
- * Sets the issue instant of the outbound message in milliseconds.
+ * Sets the issue instant of the outbound message
*
- * @param instant issue instant of the outbound message in milliseconds
+ * @param instant issue instant of the outbound message
*
* @return this builder
*/
- @Nonnull public RequestContextBuilder setOutboundMessageIssueInstant(final long instant) {
+ @Nonnull public RequestContextBuilder setOutboundMessageIssueInstant(@Nullable final Instant instant) {
outboundMessageIssueInstant = instant;
return this;
}
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML1SPSession.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML1SPSession.java
index b1c3c89..379356c 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML1SPSession.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML1SPSession.java
@@ -34,8 +34,8 @@ public class SAML1SPSession extends BasicSPSession {
* Constructor.
*
* @param id the identifier of the service associated with this session
- * @param creation creation time of session, in milliseconds since the epoch
- * @param expiration expiration time of session, in milliseconds since the epoch
+ * @param creation creation time of session
+ * @param expiration expiration time of session
*/
public SAML1SPSession(@Nonnull @NotEmpty final String id, @Nonnull final Instant creation,
@Nonnull final Instant expiration) {
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML2SPSession.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML2SPSession.java
index 35145b9..13b2722 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML2SPSession.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/session/SAML2SPSession.java
@@ -53,8 +53,8 @@ public class SAML2SPSession extends BasicSPSession {
* Constructor.
*
* @param id the identifier of the service associated with this session
- * @param creation creation time of session, in milliseconds since the epoch
- * @param expiration expiration time of session, in milliseconds since the epoch
+ * @param creation creation time of session
+ * @param expiration expiration time of session
* @param assertedNameID the NameID asserted to the SP
* @param assertedIndex the SessionIndex asserted to the SP
*/
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/BaseIdPInitiatedSSORequestMessageDecoder.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/BaseIdPInitiatedSSORequestMessageDecoder.java
index 02645cf..a78e8b5 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/BaseIdPInitiatedSSORequestMessageDecoder.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/BaseIdPInitiatedSSORequestMessageDecoder.java
@@ -156,7 +156,7 @@ public abstract class BaseIdPInitiatedSSORequestMessageDecoder<RequestType> exte
}
/**
- * Gets the current time, in milliseconds since the epoch, at the SP, if set.
+ * Gets the current time at the SP, if set.
*
* @param request current HTTP request
*
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/IdPInitiatedSSORequest.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/IdPInitiatedSSORequest.java
index b609a25..e627a0b 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/IdPInitiatedSSORequest.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/profile/impl/IdPInitiatedSSORequest.java
@@ -54,7 +54,7 @@ public class IdPInitiatedSSORequest {
/** An opaque value to be returned to the service provider with the authentication response. */
@Nullable private final String relayState;
- /** The current time, at the service provider, in milliseconds since the epoch. */
+ /** The current time, at the service provider. */
@Nonnull private final Instant time;
/**
@@ -65,7 +65,7 @@ public class IdPInitiatedSSORequest {
* @param newEntityId entity ID of the requesting SP
* @param url assertion consumer service endpoint at the SP to which to deliver the response
* @param target opaque value to be returned to the SP with the response
- * @param newTime current time at the SP, in milliseconds since the epoch, must be greater than zero
+ * @param newTime current time at the SP
*/
public IdPInitiatedSSORequest(@Nonnull @NotEmpty final String newEntityId, @Nullable final String url,
@Nullable final String target, @Nullable final Instant newTime) {
@@ -111,9 +111,9 @@ public class IdPInitiatedSSORequest {
}
/**
- * Get the current time at the SP, in milliseconds since the epoch.
+ * Get the current time at the SP.
*
- * @return current time at the SP, in milliseconds since the epoch
+ * @return current time at the SP
*/
@Nonnull public Instant getTime() {
return time;
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionCreationStrategy.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionCreationStrategy.java
index 1d5db2e..c60bdf5 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionCreationStrategy.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionCreationStrategy.java
@@ -58,7 +58,7 @@ public class SAML1SPSessionCreationStrategy implements Function<ProfileRequestCo
/**
* Constructor.
*
- * @param lifetime lifetime in milliseconds, determines expiration of {@link SPSession} to be created
+ * @param lifetime determines expiration of {@link SPSession} to be created
*/
public SAML1SPSessionCreationStrategy(@Nonnull final Duration lifetime) {
sessionLifetime = Constraint.isNotNull(lifetime, "Lifetime cannot be null");
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionSerializer.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionSerializer.java
index 8da3bb7..c4224c2 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionSerializer.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML1SPSessionSerializer.java
@@ -39,7 +39,7 @@ public class SAML1SPSessionSerializer extends AbstractSPSessionSerializer {
/**
* Constructor.
*
- * @param offset milliseconds to subtract from record expiration to establish session expiration value
+ * @param offset time to subtract from record expiration to establish session expiration value
*/
public SAML1SPSessionSerializer(@Nonnull @ParameterName(name="offset") final Duration offset) {
super(offset);
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionCreationStrategy.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionCreationStrategy.java
index 160729f..2253766 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionCreationStrategy.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionCreationStrategy.java
@@ -72,8 +72,7 @@ public class SAML2SPSessionCreationStrategy implements Function<ProfileRequestCo
/**
* Constructor.
*
- * @param lifetime lifetime in milliseconds, determines upper bound for expiration of
- * {@link SAML2SPSession} to be created
+ * @param lifetime determines upper bound for expiration of {@link SAML2SPSession} to be created
*/
public SAML2SPSessionCreationStrategy(@Nonnull final Duration lifetime) {
sessionLifetime = Constraint.isNotNull(lifetime, "Lifetime cannot be null");
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionSerializer.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionSerializer.java
index 8dc75b9..ad5fe1a 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionSerializer.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/session/impl/SAML2SPSessionSerializer.java
@@ -69,7 +69,7 @@ public class SAML2SPSessionSerializer extends AbstractSPSessionSerializer {
/**
* Constructor.
*
- * @param offset milliseconds to subtract from record expiration to establish session expiration value
+ * @param offset time to subtract from record expiration to establish session expiration value
*/
public SAML2SPSessionSerializer(@Nonnull @ParameterName(name="offset") final Duration offset) {
super(offset);
diff --git a/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractIdPSession.java b/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractIdPSession.java
index a32d41e..5bbe8cd 100644
--- a/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractIdPSession.java
+++ b/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractIdPSession.java
@@ -80,10 +80,10 @@ public abstract class AbstractIdPSession implements IdPSession {
/** A canonical name for the subject of the session. */
@Nonnull @NotEmpty private final String principalName;
- /** Time, in milliseconds since the epoch, when this session was created. */
+ /** Time when this session was created. */
@Nonnull private final Instant creationInstant;
- /** Last activity instant, in milliseconds since the epoch, for this session. */
+ /** Last activity instant for this session. */
@Nonnull private Instant lastActivityInstant;
/** Addresses to which the session is bound. */
@@ -103,7 +103,7 @@ public abstract class AbstractIdPSession implements IdPSession {
*
* @param sessionId identifier for this session
* @param canonicalName canonical name of subject
- * @param creationTime creation time of session in milliseconds
+ * @param creationTime creation time of session
*/
public AbstractIdPSession(@Nonnull @NotEmpty final String sessionId, @Nonnull @NotEmpty final String canonicalName,
@Nonnull final Instant creationTime) {
@@ -139,9 +139,9 @@ public abstract class AbstractIdPSession implements IdPSession {
}
/**
- * Set the last activity instant, in milliseconds since the epoch, for the session.
+ * Set the last activity instant for the session.
*
- * @param instant last activity instant, in milliseconds since the epoch, for the session, must be greater than 0
+ * @param instant last activity instant for the session
* @throws SessionException if an error occurs updating the session
*/
public void setLastActivityInstant(@Nonnull final Instant instant) throws SessionException {
@@ -149,12 +149,12 @@ public abstract class AbstractIdPSession implements IdPSession {
}
/**
- * Set the last activity instant, in milliseconds since the epoch, for the session.
+ * Set the last activity instant for the session.
*
* <p>This manipulates only the internal state of the object. The {@link #setLastActivityInstant(long)}
* method must be overridden to support other persistence requirements.</p>
*
- * @param instant last activity instant, in milliseconds since the epoch, for the session, must be greater than 0
+ * @param instant last activity instant for the session
*/
public void doSetLastActivityInstant(@Nonnull final Instant instant) {
lastActivityInstant = Constraint.isNotNull(instant, "Last activity instant cannot be null");
diff --git a/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractSPSessionSerializer.java b/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractSPSessionSerializer.java
index 9c6175c..af9f983 100644
--- a/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractSPSessionSerializer.java
+++ b/idp-session-api/src/main/java/net/shibboleth/idp/session/AbstractSPSessionSerializer.java
@@ -139,8 +139,8 @@ public abstract class AbstractSPSessionSerializer extends AbstractInitializableC
*
* @param obj JSON structure to parse
* @param id the identifier of the service associated with this session
- * @param creation creation time of session, in milliseconds since the epoch
- * @param expiration expiration time of session, in milliseconds since the epoch
+ * @param creation creation time of session
+ * @param expiration expiration time of session
*
* @return the newly constructed object
* @throws IOException if an error occurs during deserialization
diff --git a/idp-session-api/src/main/java/net/shibboleth/idp/session/BasicSPSession.java b/idp-session-api/src/main/java/net/shibboleth/idp/session/BasicSPSession.java
index 1cece70..c127aaa 100644
--- a/idp-session-api/src/main/java/net/shibboleth/idp/session/BasicSPSession.java
+++ b/idp-session-api/src/main/java/net/shibboleth/idp/session/BasicSPSession.java
@@ -39,18 +39,18 @@ public class BasicSPSession implements SPSession {
/** The unique identifier of the service. */
@Nonnull @NotEmpty private final String serviceId;
- /** The time, in milliseconds since the epoch, when this session was created. */
+ /** The time when this session was created. */
@Nonnull private final Instant creationInstant;
- /** The time, in milliseconds since the epoch, when this session expires. */
+ /** The time when this session expires. */
@Nonnull private final Instant expirationInstant;
/**
* Constructor.
*
* @param id the identifier of the service associated with this session
- * @param creation creation time of session, in milliseconds since the epoch
- * @param expiration expiration time of session, in milliseconds since the epoch
+ * @param creation creation time of session
+ * @param expiration expiration time of session
*/
public BasicSPSession(@Nonnull @NotEmpty final String id, @Nonnull final Instant creation,
@Nonnull final Instant expiration) {
diff --git a/idp-session-api/src/main/java/net/shibboleth/idp/session/IdPSession.java b/idp-session-api/src/main/java/net/shibboleth/idp/session/IdPSession.java
index 56092e5..4337eb9 100644
--- a/idp-session-api/src/main/java/net/shibboleth/idp/session/IdPSession.java
+++ b/idp-session-api/src/main/java/net/shibboleth/idp/session/IdPSession.java
@@ -49,16 +49,16 @@ public interface IdPSession extends IdentifiedComponent {
@Nonnull @NotEmpty public String getPrincipalName();
/**
- * Get the time, in milliseconds since the epoch, when this session was created.
+ * Get the time when this session was created.
*
- * @return time this session was created, never less than 0
+ * @return time this session was created
*/
@Nonnull public Instant getCreationInstant();
/**
- * Get the last activity instant, in milliseconds since the epoch, for the session.
+ * Get the last activity instant for the session.
*
- * @return last activity instant, in milliseconds since the epoch, for the session, never less than 0
+ * @return last activity instant for the session
*/
@Nonnull public Instant getLastActivityInstant();
diff --git a/idp-session-api/src/main/java/net/shibboleth/idp/session/SPSession.java b/idp-session-api/src/main/java/net/shibboleth/idp/session/SPSession.java
index 686235c..1229854 100644
--- a/idp-session-api/src/main/java/net/shibboleth/idp/session/SPSession.java
+++ b/idp-session-api/src/main/java/net/shibboleth/idp/session/SPSession.java
@@ -35,16 +35,16 @@ import net.shibboleth.utilities.java.support.component.IdentifiedComponent;
public interface SPSession extends IdentifiedComponent {
/**
- * Get the time, in milliseconds since the epoch, when this session was created.
+ * Get the time when this session was created.
*
- * @return time, in milliseconds since the epoch, when this session was created, never less than 0
+ * @return time when this session was created
*/
@Nonnull Instant getCreationInstant();
/**
- * Get the time, in milliseconds since the epoch, when this session will expire.
+ * Get the time when this session will expire.
*
- * @return time, in milliseconds since the epoch, when this session will expire, never less than 0
+ * @return time when this session will expire
*/
@Nonnull Instant getExpirationInstant();
diff --git a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionCreationStrategy.java b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionCreationStrategy.java
index 400c89d..345a0f7 100644
--- a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionCreationStrategy.java
+++ b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionCreationStrategy.java
@@ -57,7 +57,7 @@ public class BasicSPSessionCreationStrategy implements Function<ProfileRequestCo
/**
* Constructor.
*
- * @param lifetime lifetime in milliseconds, determines expiration of {@link SPSession} to be created
+ * @param lifetime determines expiration of {@link SPSession} to be created
*/
public BasicSPSessionCreationStrategy(@Nonnull final Duration lifetime) {
sessionLifetime = Constraint.isNotNull(lifetime, "Lifetime cannot be null");
diff --git a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionSerializer.java b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionSerializer.java
index 30295e7..0f88a68 100644
--- a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionSerializer.java
+++ b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/BasicSPSessionSerializer.java
@@ -40,7 +40,7 @@ public class BasicSPSessionSerializer extends AbstractSPSessionSerializer {
/**
* Constructor.
*
- * @param offset milliseconds to subtract from record expiration to establish session expiration value
+ * @param offset time to subtract from record expiration to establish session expiration value
*/
public BasicSPSessionSerializer(@Nonnull @ParameterName(name="offset") final Duration offset) {
super(offset);
diff --git a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/StorageBackedIdPSession.java b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/StorageBackedIdPSession.java
index 862e2d0..e82c7c5 100644
--- a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/StorageBackedIdPSession.java
+++ b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/StorageBackedIdPSession.java
@@ -68,7 +68,7 @@ public class StorageBackedIdPSession extends AbstractIdPSession {
* @param manager parent SessionManager instance
* @param sessionId unique ID of session
* @param canonicalName canonical name of session subject
- * @param creationTime creation time of session in milliseconds
+ * @param creationTime creation time of session
*/
public StorageBackedIdPSession(@Nonnull final StorageBackedSessionManager manager,
@Nonnull @NotEmpty final String sessionId, @Nonnull @NotEmpty final String canonicalName,
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list