ProxyInfoAvp.java

/*
 * Diameter Sh Resource Adaptor Type
 *
 * Copyright (C) 2006 Open Cloud Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of version 2.1 of the GNU Lesser 
 * General Public License as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
 * MA  02110-1301  USA, or see the FSF site: http://www.fsf.org.
 */
package net.java.slee.resource.diameter.base.events.avp;






/**
 * Defines an interface representing the Proxy-Info grouped AVP type.
 *
 * From the Diameter Base Protocol (rfc3588.txt) specification:
 * <pre>
 * 6.7.2.  Proxy-Info AVP
 * 
 *    The Proxy-Info AVP (AVP Code 284) is of type Grouped.  The Grouped
 *    Data field has the following ABNF grammar:
 * 
 *       Proxy-Info ::= < AVP Header: 284 >
 *                      { Proxy-Host }
 *                      { Proxy-State }
 *                    * [ AVP ]
 * </pre>
 */
public interface ProxyInfoAvp extends GroupedAvp {

    /**
     * Returns true if the Proxy-Host AVP is present in the message.
     */
    public boolean hasProxyHost();

    /**
     * Returns the value of the Proxy-Host AVP, of type DiameterIdentity.
     * A return value of null implies that the AVP has not been set.
     */
    public DiameterIdentity getProxyHost();

    /**
     * Sets the value of the Proxy-Host AVP, of type DiameterIdentity.
     * @throws IllegalStateException if setProxyHost has already been called
     */
    public void setProxyHost(DiameterIdentity proxyHost);

    /**
     * Returns true if the Proxy-State AVP is present in the message.
     */
    public boolean hasProxyState();

    /**
     * Returns the value of the Proxy-State AVP, of type OctetString.
     * A return value of null implies that the AVP has not been set.
     */
    public byte[] getProxyState();

    /**
     * Sets the value of the Proxy-State AVP, of type OctetString.
     * @throws IllegalStateException if setProxyState has already been called
     */
    public void setProxyState(byte[] proxyState);

    ///**
    // * Returns the set of extension AVPs. The returned array contains the extension AVPs
    // * in the order they appear in the message.
    // * A return value of null implies that no extensions AVPs have been set.
    // */
    //public DiameterAvp[] getExtensionAvps();

    ///**
    // * Sets the set of extension AVPs with all the values in the given array.
    // * The AVPs will be added to message in the order in which they appear in the array.
    // *
    // * Note: the array must not be altered by the caller following this call, and
    // * getExtensionAvps() is not guaranteed to return the same array instance,
    // * e.g. an "==" check would fail.
    // *
    // * @throws AvpNotAllowedException if an AVP is encountered of a type already known to this class
    // *   (i.e. an AVP for which get/set methods already appear in this class)
    // * @throws IllegalStateException if setExtensionAvps has already been called
    // */
    //public void setExtensionAvps(DiameterAvp[]  avps) throws AvpNotAllowedException;

}