View Javadoc
1   /*
2    * Copyright (C) 2013 4th Line GmbH, Switzerland
3    *
4    * The contents of this file are subject to the terms of either the GNU
5    * Lesser General Public License Version 2 or later ("LGPL") or the
6    * Common Development and Distribution License Version 1 or later
7    * ("CDDL") (collectively, the "License"). You may not use this file
8    * except in compliance with the License. See LICENSE.txt for more
9    * information.
10   *
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14   */
15  
16  package org.fourthline.cling.transport.spi;
17  
18  import org.fourthline.cling.model.UnsupportedDataException;
19  import org.fourthline.cling.model.message.gena.IncomingEventRequestMessage;
20  import org.fourthline.cling.model.message.gena.OutgoingEventRequestMessage;
21  
22  /**
23   * Reads and writes GENA XML content.
24   *
25   * @author Christian Bauer
26   */
27  public interface GENAEventProcessor {
28  
29      /**
30       * Transforms a collection of {@link org.fourthline.cling.model.state.StateVariableValue}s into an XML message body.
31       *
32       * @param requestMessage The message to transform.
33       * @throws org.fourthline.cling.model.UnsupportedDataException
34       */
35      public void writeBody(OutgoingEventRequestMessage requestMessage) throws UnsupportedDataException;
36  
37      /**
38       * Transforms an XML message body and adds to a collection of {@link org.fourthline.cling.model.state.StateVariableValue}s..
39       *
40       * @param requestMessage The message to transform.
41       * @throws UnsupportedDataException
42       */
43      public void readBody(IncomingEventRequestMessage requestMessage) throws UnsupportedDataException;
44  
45  }