org.openid4java.message.sreg.SReg11ExtensionFactory 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.sreg;

import org.openid4java.message.MessageExtensionFactory;
import org.openid4java.message.MessageExtension;
import org.openid4java.message.ParameterList;
import org.openid4java.message.MessageException;

/**
 * Custom Extension Factory for SREG 1.1 messages. Creates SRegMessage
 * objects, but sets the type URI to http://openid.net/extensions/sreg/1.1
 * for SREG 1.1.
 *
 * @author Marius Scurtescu, Johnny Bufu
 */
public class SReg11ExtensionFactory implements MessageExtensionFactory
{
    /**
     * Gets the Type URI that identifies the Simple Registration 1.1 extension.
     */
    public String getTypeUri()
    {
        return SRegMessage.OPENID_NS_SREG11;
    }

    /**
     * Instantiates the apropriate Simple Registration object
     * (request / response) for the supplied parameter list.
     *
     * Similar to SRegMessage.getExtension(), but sets the SREG 1.1 type URI.
     *
     * @param parameterList         The Simple Registration specific parameters
     *                              (without the openid. prefix)
     *                              extracted from the openid message.
     * @param isRequest             Indicates whether the parameters were
     *                              extracted from an OpenID request (true),
     *                              or from an OpenID response.
     * @return                      MessageExtension implementation for
     *                              the supplied extension parameters.
     * @throws MessageException     If a Simple Registration object could not be
     *                              instantiated from the supplied parameter list.
     */
    public MessageExtension getExtension(
            ParameterList parameterList, boolean isRequest)
            throws MessageException
    {
        SRegMessage sreg;

        if ( parameterList.hasParameter("required") ||
             parameterList.hasParameter("optional"))

            sreg = SRegRequest.createSRegRequest(parameterList);

        else
            sreg = SRegResponse.createSRegResponse(parameterList);

        sreg.setTypeUri(SRegMessage.OPENID_NS_SREG11);

        return sreg;
    }
}