com.electronicpanopticon.spring.web.rest.RestClient.java Source code

Introduction

Here is the source code for com.electronicpanopticon.spring.web.rest.RestClient.java

Source

/*
 * LICENSE: http://creativecommons.org/licenses/by-sa/3.0/
 */
package com.electronicpanopticon.spring.web.rest;

import java.net.URI;

import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;

import com.google.common.base.Preconditions;
import com.google.common.base.Strings;

/**
 * A sample class to represent a rest client so that you can call into an app secured with spring security.
 * 
 * @author <a href="http://stackoverflow.com/users/438319/ams">ams</a>
 * @see <a href="http://stackoverflow.com/a/11688712/1245251">Spring Security
 *      Authentication using RestTemplate</a>
 */
public class RestClient {
    private String host = "localhost";
    private String port = "8080";
    private String applicationPath;
    private String apiPath = "api";
    private String loginPath = "j_spring_security_check";
    private String logoutPath = "logout";
    private final String usernameInputFieldName = "j_username";
    private final String passwordInputFieldName = "j_password";
    private final StatefullRestTemplate template = new StatefullRestTemplate();

    /**
     * This method logs into a service by doing an standard http using the
     * configuration in this class.
     * 
     * @param username
     *            the username to log into the application with
     * @param password
     *            the password to log into the application with
     * 
     * @return the url that the login redirects to
     */
    public String login(String username, String password) {
        MultiValueMap<String, String> form = new LinkedMultiValueMap<String, String>();
        form.add(usernameInputFieldName, username);
        form.add(passwordInputFieldName, password);
        URI location = this.template.postForLocation(loginUrl(), form);
        return location.toString();
    }

    /**
     * Logout by doing an http get on the logout url
     * 
     * @return result of the get as ResponseEntity
     */
    public ResponseEntity<String> logout() {
        return this.template.getForEntity(logoutUrl(), String.class);
    }

    public String applicationUrl(String relativePath) {
        return applicationUrl() + "/" + Preconditions.checkNotNull(relativePath);
    }

    public String apiUrl(String relativePath) {
        return applicationUrl(apiPath + "/" + Preconditions.checkNotNull(relativePath));
    }

    public StatefullRestTemplate template() {
        return template;
    }

    public String serverUrl() {
        return "http://" + host + ":" + port;
    }

    public String applicationUrl() {
        return serverUrl() + "/" + Strings.nullToEmpty(applicationPath);
    }

    public String loginUrl() {
        return applicationUrl(loginPath);
    }

    public String logoutUrl() {
        return applicationUrl(logoutPath);
    }

    public String apiUrl() {
        return applicationUrl(apiPath);
    }

    public void setLogoutPath(String logoutPath) {
        this.logoutPath = logoutPath;
    }

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public String getPort() {
        return port;
    }

    public void setPort(String port) {
        this.port = port;
    }

    public String getApplicationPath() {
        return applicationPath;
    }

    public void setApplicationPath(String contextPath) {
        this.applicationPath = contextPath;
    }

    public String getApiPath() {
        return apiPath;
    }

    public void setApiPath(String apiPath) {
        this.apiPath = apiPath;
    }

    public String getLoginPath() {
        return loginPath;
    }

    public void setLoginPath(String loginPath) {
        this.loginPath = loginPath;
    }

    public String getLogoutPath() {
        return logoutPath;
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("RestClient [\n serverUrl()=");
        builder.append(serverUrl());
        builder.append(", \n applicationUrl()=");
        builder.append(applicationUrl());
        builder.append(", \n loginUrl()=");
        builder.append(loginUrl());
        builder.append(", \n logoutUrl()=");
        builder.append(logoutUrl());
        builder.append(", \n apiUrl()=");
        builder.append(apiUrl());
        builder.append("\n]");
        return builder.toString();
    }
}