GUAC-1451: Add standard GUAC_DATE and GUAC_TIME parameter tokens.

This commit is contained in:
Michael Jumper
2016-01-22 11:39:51 -08:00
parent 4fc5da50de
commit 22f650b4f7

View File

@@ -1,5 +1,5 @@
/*
* Copyright (C) 2015 Glyptodon LLC
* Copyright (C) 2016 Glyptodon LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -22,6 +22,8 @@
package org.glyptodon.guacamole.token;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.glyptodon.guacamole.net.auth.Credentials;
/**
@@ -42,15 +44,41 @@ public class StandardTokens {
*/
private static final String PASSWORD_TOKEN = "GUAC_PASSWORD";
/**
* The name of the date token (server-local time) added via
* addStandardTokens().
*/
private static final String DATE_TOKEN = "GUAC_DATE";
/**
* The name of the time token (server-local time) added via
* addStandardTokens().
*/
private static final String TIME_TOKEN = "GUAC_TIME";
/**
* The date format that should be used for the date token. This format must
* be compatible with Java's SimpleDateFormat.
*/
private static final String DATE_FORMAT = "yyyyMMdd";
/**
* The date format that should be used for the time token. This format must
* be compatible with Java's SimpleDateFormat.
*/
private static final String TIME_FORMAT = "HHmmss";
/**
* This utility class should not be instantiated.
*/
private StandardTokens() {}
/**
* Adds the standard username (GUAC_USERNAME) and password (GUAC_PASSWORD)
* tokens to the given TokenFilter using the values from the given
* Credentials object. If either the username or password are not set
* Adds tokens which are standardized by guacamole-ext to the given
* TokenFilter using the values from the given Credentials object. These
* standardized tokens include the current username (GUAC_USERNAME),
* password (GUAC_PASSWORD), and the server date and time (GUAC_DATE and
* GUAC_TIME respectively). If either the username or password are not set
* within the given credentials, the corresponding token(s) will remain
* unset.
*
@@ -59,7 +87,6 @@ public class StandardTokens {
*
* @param credentials
* The Credentials containing the username/password to add.
*
*/
public static void addStandardTokens(TokenFilter filter, Credentials credentials) {
@@ -73,7 +100,11 @@ public class StandardTokens {
if (password != null)
filter.setToken(PASSWORD_TOKEN, password);
}
// Add date/time tokens (server-local time)
Date currentTime = new Date();
filter.setToken(DATE_TOKEN, new SimpleDateFormat(DATE_FORMAT).format(currentTime));
filter.setToken(TIME_TOKEN, new SimpleDateFormat(TIME_FORMAT).format(currentTime));
}
}