org.openid4java.message.AssociationError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openid4java-nodeps Show documentation
The newest version!
/*
 * Copyright 2006-2008 Sxip Identity Corporation
 */

package org.openid4java.message;

import org.openid4java.association.AssociationSessionType;
import org.openid4java.OpenIDException;

import java.util.List;
import java.util.Arrays;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * @author Marius Scurtescu, Johnny Bufu
 */
public class AssociationError extends DirectError
{
    private static Log _log = LogFactory.getLog(AssociationError.class);

    public static final String ASSOC_ERR = "unsupported-type";

    protected final static List requiredFields = Arrays.asList( new String[] {
            "ns",
            "error_code",
            "error",
    });

    protected final static List optionalFields = Arrays.asList( new String[] {
            "assoc_type",
            "session_type"
    });

    protected AssociationError(String msg, AssociationSessionType type)
    {
        super(msg);

        set("ns", OPENID2_NS);
        set("error_code", ASSOC_ERR);
        set("session_type", type.getSessionType());
        set("assoc_type", type.getAssociationType());
    }

    protected AssociationError(ParameterList params)
    {
        super(params);
    }

    public static AssociationError createAssociationError(
            String msg, AssociationSessionType type)
    {
        AssociationError err = new AssociationError(msg, type);

        try
        {
            err.validate();
        }
        catch (MessageException e)
        {
            _log.error("Invalid association error message created, " +
                       "type: " + type + " message: " + msg, e);
        }

        return err;
    }

    public static AssociationError createAssociationError(ParameterList params)
    {
        AssociationError err = new AssociationError(params);

        try
        {
            err.validate();
        }
        catch (MessageException e)
        {
            _log.error("Invalid association error message created: "
                       + err.keyValueFormEncoding(), e );
        }

        return err;
    }

    public List getRequiredFields()
    {
        return requiredFields;
    }

    public void setAssociationSessionType(AssociationSessionType type)
    {
        set("session_type", type.getSessionType());
        set("assoc_type", type.getAssociationType());
    }

    public String getSessionType()
    {
        return getParameterValue("session_type");
    }

    public String getAssocType()
    {
        return getParameterValue("assoc_type");
    }

    private String getErrorCode()
    {
        return getParameterValue("error_code");
    }

    public void validate() throws MessageException
    {
        super.validate();

        if ( ! (ASSOC_ERR.equals(getErrorCode()) &&
                OPENID2_NS.equals(getParameterValue("ns")) ) )
            throw new MessageException("Invalid Association Error: " +
                "invalid error_code or missing ns param.",
                OpenIDException.ASSOC_ERROR);
    }

}