org.jdiameter.api.Request Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdiameter-api Show documentation
There is a newer version: 1.7.1-123
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2006, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jdiameter.api;

/**
 * A Diameter Request is a request from a client to a server (or server to client - network request).
 * 
 * @author [email protected]
 * @author [email protected]
 * @author  Alexandre Mendonca 
 * @author  Bartosz Baranowski 
 */
public interface Request extends Message {

  /**
   * @return true if it is network request
   */
  boolean isNetworkRequest();

  /**
   * Creates an answer for this request with the specified result code.
   * Header and system AVPs from request are copied to answer.
   * @param resultCode result code of answer
   * @return answer object instance
   */
  Answer createAnswer(long resultCode);

  /**
   * Creates an answer for this request with the specified experimental result code.
   * Header and system AVPs from request are copied to answer.
   * @param vendorId vendorId
   * @param experimentalResultCode experimental result code of answer
   * @return answer object instance
   */
  Answer createAnswer(long vendorId, long experementalResultCode);

  /**
   * Creates answer for this request. Header and system AVPs from request are copied to answer.
   * @return
   */
  Answer createAnswer();

}