/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/MAPServiceBase.java

  1/*
  2 * JBoss, Home of Professional Open Source
  3 * Copyright 2011, Red Hat, Inc. and individual contributors
  4 * by the @authors tag. See the copyright.txt in the distribution for a
  5 * full listing of individual contributors.
  6 *
  7 * This is free software; you can redistribute it and/or modify it
  8 * under the terms of the GNU Lesser General Public License as
  9 * published by the Free Software Foundation; either version 2.1 of
 10 * the License, or (at your option) any later version.
 11 *
 12 * This software is distributed in the hope that it will be useful,
 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 15 * Lesser General Public License for more details.
 16 *
 17 * You should have received a copy of the GNU Lesser General Public
 18 * License along with this software; if not, write to the Free
 19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 21 */
 22
 23package org.mobicents.protocols.ss7.map.api;
 24
 25import org.mobicents.protocols.ss7.map.api.dialog.ServingCheckData;
 26import org.mobicents.protocols.ss7.map.api.primitives.AddressString;
 27import org.mobicents.protocols.ss7.sccp.parameter.SccpAddress;
 28
 29/**
 30 * 
 31 * @author sergey vetyutnev
 32 * 
 33 */
 34public interface MAPServiceBase {
 35
 36	public MAPProvider getMAPProvider();
 37
 38	/**
 39	 * Creates a new Dialog. This is equivalent to issuing MAP_OPEN Service
 40	 * Request to MAP Provider.
 41	 * 
 42	 * @param applicationCntx
 43	 *            This parameter identifies the type of application context
 44	 *            being established. If the dialogue is accepted the received
 45	 *            application context name shall be echoed. In case of refusal
 46	 *            of dialogue this parameter shall indicate the highest version
 47	 *            supported.
 48	 * 
 49	 * @param destAddress
 50	 *            A valid SCCP address identifying the destination peer entity.
 51	 *            As an implementation option, this parameter may also, in the
 52	 *            indication, be implicitly associated with the service access
 53	 *            point at which the primitive is issued.
 54	 * 
 55	 * @param destReference
 56	 *            This parameter is a reference which refines the identification
 57	 *            of the called process. It may be identical to Destination
 58	 *            address but its value is to be carried at MAP level.
 59	 * 
 60	 * @param origAddress
 61	 *            A valid SCCP address identifying the requestor of a MAP
 62	 *            dialogue. As an implementation option, this parameter may
 63	 *            also, in the request, be implicitly associated with the
 64	 *            service access point at which the primitive is issued.
 65	 * 
 66	 * @param origReference
 67	 *            This parameter is a reference which refines the identification
 68	 *            of the calling process. It may be identical to the Originating
 69	 *            address but its value is to be carried at MAP level.
 70	 *            Processing of the Originating-reference shall be performed
 71	 *            according to the supplementary service descriptions and other
 72	 *            service descriptions, e.g. operator determined barring.
 73	 * @return
 74	 */
 75	public MAPDialog createNewDialog(MAPApplicationContext appCntx, SccpAddress origAddress,
 76			AddressString origReference, SccpAddress destAddress, AddressString destReference) throws MAPException;
 77
 78	/**
 79	 * Returns true if the service can perform dialogs with given
 80	 * ApplicationContext
 81	 */
 82	public ServingCheckData isServingService(MAPApplicationContext dialogApplicationContext);
 83
 84//	/**
 85//	 * Generate ApplicationContext depending on operationCode for MAP v1
 86//	 * 
 87//	 * @param operationCode
 88//	 * @param invoke
 89//	 * @return ApplicationContext or null if operationCode is not supported by a service
 90//	 */
 91//	public MAPApplicationContext getMAPv1ApplicationContext(int operationCode, Invoke invoke); 
 92//
 93//	/**
 94//	 * Process a component
 95//	 */
 96//	public void processComponent(ComponentType compType, OperationCode oc, Parameter parameter, MAPDialog mapDialog, Long invokeId, Long linkedId)
 97//			throws MAPParsingComponentException;
 98
 99
100	public boolean isActivated();
101
102	public void acivate();
103
104	public void deactivate();
105}