1 /* 2 * Copyright (c) 2007, 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.api.client; 36 37 import java.util.Properties; 38 39 import org.ogf.graap.wsag.api.security.ISecurityProperties; 40 import org.w3.x2005.x08.addressing.EndpointReferenceType; 41 42 /** 43 * WsClient 44 * 45 * @author Oliver Waeldrich 46 */ 47 public interface WsClient 48 { 49 50 /** 51 * Returns the security properties used by the web-service client. 52 * 53 * @return the security properties for this client 54 */ 55 ISecurityProperties getSecurityProperties(); 56 57 /** 58 * Returns the properties used by the web-service client. 59 * 60 * @return a list of properties associated with the client 61 */ 62 Properties getProperties(); 63 64 /** 65 * Sets the properties used for the web-service client. 66 * 67 * @param properties 68 * Sets the properties for this client 69 */ 70 void setProperties( Properties properties ); 71 72 /** 73 * Returns the endpoint of the client instance. 74 * 75 * @return Returns the endpoint reference for this WS resource. 76 */ 77 EndpointReferenceType getEndpoint(); 78 79 /** 80 * Determines whether or not a client prints the web-service messages to the console. 81 * 82 * @return true, if the web service client traces the incoming/outgoing messages. 83 */ 84 boolean isUsingTrace(); 85 86 /** 87 * Sets the clients trace mode. 88 * 89 * @param trace 90 * true, if the web service client should traces incoming/outgoing messages. 91 */ 92 void setTrace( boolean trace ); 93 94 }