Sy Protocol Implementation

core/jdiameter/api/src/main/java/org/jdiameter/api/sy/ClientSySession.java

@@ -0,0 +1,78 @@
+ /*
+  * TeleStax, Open Source Cloud Communications
+  * Copyright 2011-2016, TeleStax Inc. and individual contributors
+  * by the @authors tag.
+  *
+  * This program is free software: you can redistribute it and/or modify
+  * under the terms of the GNU Affero General Public License as
+  * published by the Free Software Foundation; either version 3 of
+  * the License, or (at your option) any later version.
+  *
+  * This program 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 Affero General Public License for more details.
+  *
+  * You should have received a copy of the GNU Affero General Public License
+  * along with this program.  If not, see <http://www.gnu.org/licenses/>
+  *
+  * This file incorporates work covered by the following copyright and
+  * permission notice:
+  *
+  *   JBoss, Home of Professional Open Source
+  *   Copyright 2007-2011, 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.sy;
+
+import org.jdiameter.api.IllegalDiameterStateException;
+import org.jdiameter.api.InternalException;
+import org.jdiameter.api.OverloadException;
+import org.jdiameter.api.RouteException;
+import org.jdiameter.api.app.AppSession;
+import org.jdiameter.api.app.StateMachine;
+
+import org.jdiameter.api.sy.events.SpendingLimitRequest;
+import org.jdiameter.api.sy.events.SpendingTerminationRequest;
+import org.jdiameter.api.sy.events.SpendingNotificationAnswer;
+
+/**
+ * Basic class for Sy Client Interface specific session.
+ * Listener must be injected from constructor of implementation class.
+ *
+ * @author <a href="mailto:[email protected]"> Alejandro Ferreira Guido </a>
+ * @author <a href="mailto:[email protected]"> Alexandre Mendonca </a>
+ * @author <a href="mailto:[email protected]"> Bartosz Baranowski </a>
+ */
+public interface ClientSySession extends AppSession, StateMachine {
+
+  void sendInitialSpendingLimitReportRequest(SpendingLimitRequest request)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void sendIntermediateSpendingLimitReportRequest(SpendingLimitRequest request)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void sendFinalSpendingLimitReportRequest(SpendingTerminationRequest request)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void sendSpendingLimitReportAnswer(SpendingNotificationAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+}

core/jdiameter/api/src/main/java/org/jdiameter/api/sy/ClientSySessionListener.java

@@ -0,0 +1,78 @@
+ /*
+  * TeleStax, Open Source Cloud Communications
+  * Copyright 2011-2016, TeleStax Inc. and individual contributors
+  * by the @authors tag.
+  *
+  * This program is free software: you can redistribute it and/or modify
+  * under the terms of the GNU Affero General Public License as
+  * published by the Free Software Foundation; either version 3 of
+  * the License, or (at your option) any later version.
+  *
+  * This program 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 Affero General Public License for more details.
+  *
+  * You should have received a copy of the GNU Affero General Public License
+  * along with this program.  If not, see <http://www.gnu.org/licenses/>
+  *
+  * This file incorporates work covered by the following copyright and
+  * permission notice:
+  *
+  *   JBoss, Home of Professional Open Source
+  *   Copyright 2007-2011, 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.sy;
+
+import org.jdiameter.api.IllegalDiameterStateException;
+import org.jdiameter.api.InternalException;
+import org.jdiameter.api.OverloadException;
+import org.jdiameter.api.RouteException;
+
+import org.jdiameter.api.sy.events.SpendingLimitRequest;
+import org.jdiameter.api.sy.events.SpendingLimitAnswer;
+import org.jdiameter.api.sy.events.SpendingTerminationRequest;
+import org.jdiameter.api.sy.events.SpendingTerminationAnswer;
+import org.jdiameter.api.sy.events.SpendingNotificationAnswer;
+
+/**
+* This interface defines the possible actions for the different states in the client
+* Sy Interface state machine.
+*
+* @author <a href="mailto:[email protected]"> Alejandro Ferreira Guido </a>
+* @author <a href="mailto:[email protected]"> Alexandre Mendonca </a>
+* @author <a href="mailto:[email protected]"> Bartosz Baranowski </a>
+*/
+public interface ClientSySessionListener {
+
+  void doInitialSpendingLimitReportAnswer(ClientSySession session, SpendingLimitRequest request, SpendingLimitAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void doIntermediateSpendingLimitReportAnswer(ClientSySession session, SpendingLimitRequest request, SpendingLimitAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void doFinalSpendingLimitReportAnswer(ClientSySession session, SpendingTerminationRequest request, SpendingTerminationAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void doSpendingLimitReportRequest(ClientSySession session, SpendingNotificationAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+}

core/jdiameter/api/src/main/java/org/jdiameter/api/sy/ServerSySession.java

@@ -0,0 +1,79 @@
+ /*
+  * TeleStax, Open Source Cloud Communications
+  * Copyright 2011-2016, TeleStax Inc. and individual contributors
+  * by the @authors tag.
+  *
+  * This program is free software: you can redistribute it and/or modify
+  * under the terms of the GNU Affero General Public License as
+  * published by the Free Software Foundation; either version 3 of
+  * the License, or (at your option) any later version.
+  *
+  * This program 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 Affero General Public License for more details.
+  *
+  * You should have received a copy of the GNU Affero General Public License
+  * along with this program.  If not, see <http://www.gnu.org/licenses/>
+  *
+  * This file incorporates work covered by the following copyright and
+  * permission notice:
+  *
+  *   JBoss, Home of Professional Open Source
+  *   Copyright 2007-2011, 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.sy;
+
+import org.jdiameter.api.IllegalDiameterStateException;
+import org.jdiameter.api.InternalException;
+import org.jdiameter.api.OverloadException;
+import org.jdiameter.api.RouteException;
+import org.jdiameter.api.app.AppSession;
+import org.jdiameter.api.app.StateMachine;
+
+import org.jdiameter.api.sy.events.SpendingLimitAnswer;
+import org.jdiameter.api.sy.events.SpendingTerminationRequest;
+import org.jdiameter.api.sy.events.SpendingNotificationRequest;
+
+/**
+* Basic class for Sy Server Interface specific session.
+* Listener must be injected from constructor of implementation class
+*
+* @author <a href="mailto:[email protected]"> Alejandro Ferreira Guido </a>
+* @author <a href="mailto:[email protected]"> Alexandre Mendonca </a>
+* @author <a href="mailto:[email protected]"> Bartosz Baranowski </a>
+*/
+
+public interface ServerSySession extends AppSession, StateMachine {
+
+  void sendInitialSpendingLimitReportAnswer(SpendingLimitAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void sendIntermediateSpendingLimitReportAnswer(SpendingLimitAnswer request)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void sendFinalSpendingLimitReportAnswer(SpendingTerminationRequest request)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void sendSpendingLimitReportRequest(SpendingNotificationRequest request)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+}

core/jdiameter/api/src/main/java/org/jdiameter/api/sy/ServerSySessionListener.java

@@ -0,0 +1,78 @@
+ /*
+  * TeleStax, Open Source Cloud Communications
+  * Copyright 2011-2016, TeleStax Inc. and individual contributors
+  * by the @authors tag.
+  *
+  * This program is free software: you can redistribute it and/or modify
+  * under the terms of the GNU Affero General Public License as
+  * published by the Free Software Foundation; either version 3 of
+  * the License, or (at your option) any later version.
+  *
+  * This program 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 Affero General Public License for more details.
+  *
+  * You should have received a copy of the GNU Affero General Public License
+  * along with this program.  If not, see <http://www.gnu.org/licenses/>
+  *
+  * This file incorporates work covered by the following copyright and
+  * permission notice:
+  *
+  *   JBoss, Home of Professional Open Source
+  *   Copyright 2007-2011, 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.sy;
+
+import org.jdiameter.api.IllegalDiameterStateException;
+import org.jdiameter.api.InternalException;
+import org.jdiameter.api.OverloadException;
+import org.jdiameter.api.RouteException;
+
+import org.jdiameter.api.sy.events.SpendingLimitAnswer;
+import org.jdiameter.api.sy.events.SpendingLimitRequest;
+import org.jdiameter.api.sy.events.SpendingTerminationRequest;
+import org.jdiameter.api.sy.events.SpendingNotificationAnswer;
+import org.jdiameter.api.sy.events.SpendingTerminationAnswer;
+
+/**
+* This interface defines the possible actions for th;e different states in the server Sy
+* Interface state machine.
+*
+* @author <a href="mailto:[email protected]"> Alejandro Ferreira Guido </a>
+* @author <a href="mailto:[email protected]"> Alexandre Mendonca </a>
+* @author <a href="mailto:[email protected]"> Bartosz Baranowski </a>
+*/
+public interface ServerSySessionListener {
+
+  void doInitialSpendingLimitReportRequest(ClientSySession session, SpendingLimitRequest request, SpendingLimitAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void doIntermediateSpendingLimitReportRequest(ClientSySession session, SpendingLimitRequest request, SpendingLimitAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void doFinalSpendingLimitReportRequest(ClientSySession session, SpendingTerminationRequest request, SpendingTerminationAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+  void doSpendingLimitReportAnswer(ClientSySession session, SpendingNotificationAnswer answer)
+      throws InternalException, IllegalDiameterStateException, RouteException, OverloadException;
+
+}

core/jdiameter/api/src/main/java/org/jdiameter/api/sy/events/SessionTerminationAnswer.java

@@ -0,0 +1,62 @@
+/*
+* TeleStax, Open Source Cloud Communications
+* Copyright 2011-2016, TeleStax Inc. and individual contributors
+* by the @authors tag.
+*
+* This program is free software: you can redistribute it and/or modify
+* under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation; either version 3 of
+* the License, or (at your option) any later version.
+*
+* This program 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 Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>
+*
+* This file incorporates work covered by the following copyright and
+* permission notice:
+*
+*   JBoss, Home of Professional Open Source
+*   Copyright 2007-2011, 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.sy.events;
+
+import org.jdiameter.api.app.AppAnswerEvent;
+
+/**
+* The Spending-Termination-Answer (STA) message, indicated by the Command-Code field set to 275 is sent
+* by the OCS to the PCRF in reply to the STR message.
+*
+* @author <a href="mailto:[email protected]"> Alejandro Ferreira Guido </a>
+* @author <a href="mailto:[email protected]"> Bartosz Baranowski </a>
+* @author <a href="mailto:[email protected]"> Alexandre Mendonca </a>
+*/
+public interface SessionTerminationAnswer extends AppAnswerEvent {
+
+  String _SHORT_NAME = "STA";
+  String _LONG_NAME = "Session-Termination-Answer";
+
+  int code = 275;
+
+}