View Javadoc

1   /* 
2    * Copyright (c) 2012, Fraunhofer-Gesellschaft
3    * All rights reserved.
4    * 
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are
7    * met:
8    * 
9    * (1) Redistributions of source code must retain the above copyright
10   *     notice, this list of conditions and the disclaimer at the end.
11   *     Redistributions in binary form must reproduce the above copyright
12   *     notice, this list of conditions and the following disclaimer in
13   *     the documentation and/or other materials provided with the
14   *     distribution.
15   * 
16   * (2) Neither the name of Fraunhofer nor the names of its
17   *     contributors may be used to endorse or promote products derived
18   *     from this software without specific prior written permission.
19   * 
20   * DISCLAIMER
21   * 
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33   *  
34   */
35  package org.ogf.graap.wsag.client.api.impl;
36  
37  import java.util.Properties;
38  
39  import org.ogf.graap.wsag.api.security.ISecurityProperties;
40  import org.ogf.graap.wsag.client.api.RemoteClient;
41  import org.w3.x2005.x08.addressing.EndpointReferenceType;
42  
43  /**
44   * @author owaeld
45   * 
46   */
47  public abstract class AbstractClient
48  {
49      /**
50       * 
51       */
52      public AbstractClient()
53      {
54          super();
55      }
56  
57      /**
58       * Returns the remote reference of the remote client. Remote references are encapsulated as endpoint
59       * references.
60       * 
61       * @return the remote reference
62       */
63      public EndpointReferenceType getRemoteReference()
64      {
65          return getRemoteClient().getRemoteReference();
66      }
67  
68      /**
69       * Returns the remote client used by this implementation in order to communicate with the WSAG4J server.
70       * 
71       * @return the remote client
72       */
73      public abstract RemoteClient getRemoteClient();
74  
75      /**
76       * Returns the properties of the remote client.
77       * 
78       * @return the remote client properties
79       */
80      public Properties getProperties()
81      {
82          return getRemoteClient().getProperties();
83      }
84  
85      /**
86       * Sets the properties for the remote client.
87       * 
88       * @param properties
89       *            the remote client properties
90       */
91      public void setProperties( Properties properties )
92      {
93          getRemoteClient().setProperties( properties );
94      }
95  
96      /**
97       * Returns whether or not the remote client traces the messages to the console.
98       * 
99       * @return trace mode enabled
100      */
101     public boolean isUsingTrace()
102     {
103         return getRemoteClient().isUsingTrace();
104     }
105 
106     /**
107      * Sets whether or not the remote client traces the messages to the console.
108      * 
109      * @param trace
110      *            trace mode
111      */
112     public void setTrace( boolean trace )
113     {
114         getRemoteClient().setTrace( trace );
115     }
116 
117     /**
118      * Returns the security properties of the remote client.
119      * 
120      * @return the security properties for this client
121      */
122     public ISecurityProperties getSecurityProperties()
123     {
124         return getRemoteClient().getSecurityProperties();
125     }
126 
127 }