HeaderMessage.java

/*
 * Copyright (c) 2013 GigaSpaces Technologies Ltd. All rights reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package server;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.codehaus.jackson.annotate.JsonProperty;

import play.data.Form;
import play.data.validation.ValidationError;
import play.libs.Json;
import utils.CollectionUtils;

/**
 * User: guym
 * Date: 12/27/12
 * Time: 10:41 AM
 *
 * Send GUI headers to show a message
 *
 */
public class HeaderMessage<T extends HeaderMessage> {

    protected static final String DISPLAY_MESSAGE = "display-message";
    @JsonProperty("msg")
    public String message;

    @JsonProperty("formErrors")
    public Map<String,String> formErrors = new HashMap<String,String>();


    protected String headerKey = DISPLAY_MESSAGE;

    public static enum Type{
        SUCCESS, ERROR
    }

    @JsonProperty("class")
    public Type type;

    public T setMessage( String message )
    {
        this.message = message;
        return (T) this;
    }

    private T _addFormError( String fieldName, String message ){
        formErrors.put(fieldName,message);
        return (T) this;
    }

    // guy - copied this code from Form..
    // it seems ridiculous to me that Form is responsible to build my response. wrong design.
    // the header message is better since we decided it should construct messages transferred on the header.
    // plus - since we use angularJS, I'd rather have my I18N on the client side.
    // so instead of referring to the language here, I will send the key.
    // we cannot send anything else other than ASCII in a header anyway.
    public T populateFormErrors( Form f ){
        Map<String, List<ValidationError>> errors = f.errors();
        for ( String s : errors.keySet() ) {
            List<ValidationError> validationErrors = errors.get( s );
            ValidationError first = CollectionUtils.first( validationErrors );
            addFormError( s, first.message()  );
        }
        return (T) this;
    }



    public T addFormError( String fieldName, String message ){
        return (T) setMessage( message ).setType( Type.ERROR )._addFormError( fieldName, message );
    }

    private T setHeaderKey( String value ){
        headerKey = value;
        return (T) this;
    }

    public T setSuccess( String message ){
        return (T) setMessage( message ).setType( Type.SUCCESS );
    }

    public T setError( String message ){
        return (T) setMessage( message ).setType( Type.ERROR );
    }

    public T setType( Type type )
    {
        this.type = type;
        return (T) this;
    }

    public String toJson(){
        return Json.toJson(this).toString();
    }
    public void apply( Map<String, String> headers ){
        headers.put( headerKey,toJson() );
    }
}