com.nimbusds.common.jsonrpc2.WsInfoRequestHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common Show documentation
Common Connect2id software classes
There is a newer version: 3.7
package com.nimbusds.common.jsonrpc2;


import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

import com.thetransactioncompany.jsonrpc2.JSONRPC2Error;
import com.thetransactioncompany.jsonrpc2.JSONRPC2Request;
import com.thetransactioncompany.jsonrpc2.JSONRPC2Response;
import com.thetransactioncompany.jsonrpc2.server.MessageContext;
import com.thetransactioncompany.jsonrpc2.server.RequestHandler;


/**
 * Handles JSON-RPC 2.0 requests for general information about a web service.
 * The {@link #init} method must be called before servicing requests.
 *
 * List of the handled requests:
 *
 * 

 *     ws.getName Reports the web service name (as a string).
 *     
ws.getVersion Reports the web service version (as a string).
 *     
ws.getTime Reports the local server time (as a string).
 * 
 */
public class WsInfoRequestHandler
	implements RequestHandler {
	
	
	/**
	 * ISO 8601 date/time format.
	 */
	private final static SimpleDateFormat iso8601DateTimeFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
	
	
	/**
	 * The web service name and version to report.
	 */
	private WsInfo wsInfo;
	
	
	/** 
	 * The handled request names. 
	 */
	private static final String[] HANDLED_REQUESTS = {"ws.getName", "ws.getVersion", "ws.getTime"};
	
	
	/**
	 * Initialises this WS info request handler.
	 *
	 * @param wsInfo The web service name and version to report. Must not be 
	 *               {@code null}.
	 */
	public void init(final WsInfo wsInfo) {
	
		if (wsInfo == null)
			throw new IllegalArgumentException("The web service info must not be null");
	
		this.wsInfo = wsInfo;
		
		iso8601DateTimeFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
	}
	
	
	/**
	 * Lists the JSON-RPC 2.0 request method names that this handler 
	 * processes.
	 *
	 * @return The method names of the served JSON-RPC 2.0 requests.
	 */
	public String[] handledRequests() {
	
		return HANDLED_REQUESTS;
	}
	
	
	/**
	 * Returns the local web service time in 
	 * ISO-8601 format
	 * {@code yyyy-MM-dd'T'HH:mm:ssZ} (UTC timezone), for example 
	 * "2012-07-20T13:53:51Z".
	 *
	 * @return The local web server time (UTC timezone).
	 */
	private String getWsTime() {
	
		Date now = new Date();
		
		// Append UTC timezone as Z
		return iso8601DateTimeFormat.format(now) + "Z";
	}

	
	/**
	 * Processes JSON-RPC 2.0 requests for general information about this 
	 * web service.
	 *
	 * @param request    The JSON-RPC 2.0 request.
	 * @param requestCtx Additional information about the request.
	 *
	 * @return The JSON-RPC 2.0 response.
	 */
	public JSONRPC2Response process(final JSONRPC2Request request, final MessageContext requestCtx) {
	
		// Get the request method
		String method = request.getMethod();
		
		// Get the request ID
		Object id = request.getID();
		
		// Process the requests		
		Object result;
		
		try {
			switch (method) {
				case "ws.getName":
					result = wsInfo.getName();
					break;
				case "ws.getVersion":
					result = wsInfo.getVersion();
					break;
				case "ws.getTime":
					result = getWsTime();
					break;
				default:
					throw JSONRPC2Error.METHOD_NOT_FOUND;
			}
			
		} catch (JSONRPC2Error e) {
			
			// Return response with error
			return new JSONRPC2Response(e, id);
		}
		
		// Return response with result
		return new JSONRPC2Response(result, id);
	}
}