org.jdiameter.api.cca.events.JCreditControlRequest 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 2010, 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.cca.events;

import org.jdiameter.api.app.AppRequestEvent;

/**
 * The Credit-Control-Request message (CCR) is indicated by the command-code field being set to
 * 272 and the 'R' bit being set in the Command Flags field.  It is used between the Diameter
 * credit-control client and the credit-control server to request credit authorization for a given
 * service.
 * 
 * The Auth-Application-Id MUST be set to the value 4, indicating the Diameter credit-control
 * application.
 * 
 * @author  Bartosz Baranowski 
 * @author  Alexandre Mendonca 
 */
public interface JCreditControlRequest extends AppRequestEvent {

  public static final String _SHORT_NAME = "CCR";
  public static final String _LONG_NAME = "Credit-Control-Request";

  public static final int code = 272;

  boolean isRequestedActionAVPPresent();

  int getRequestedActionAVPValue();

  boolean isRequestTypeAVPPresent();

  int getRequestTypeAVPValue();

}