* Parser for HTTP Monitor logs. Uses JAXB for parsing and is therefore quite simple. For each - * exchange in the log, it creates an appropriate event. + * exchange in the log, it creates an appropriate event. It differes between default HTTP events + * and SOAP events. *
* @@ -50,4 +60,11 @@ */ private Collection+ * the message factory used for parsing SOAP messages + *
+ */ + private MessageFactory soapMessageFactory; /** @@ -97,5 +114,5 @@ List+ * instantiates the appropriate event type. If it encounters a SOAP exchange, a SOAP event type + * is instantiated. Otherwise a normal HTTP event type is created. + *
+ * + * @param exchange the exchange for which an event type is to be created + * + * @return as described + */ + private IEventType createEvent(HttpExchange exchange) { + Content requestContent = + exchange.getRequest() != null ? exchange.getRequest().getContent() : null; + + SOAPMessage soapRequest = getSOAPMessage(requestContent); + + Content responseContent = + exchange.getResponse() != null ? exchange.getResponse().getContent() : null; + + SOAPMessage soapResponse = getSOAPMessage(responseContent); + + if (soapRequest != null) { + return new SOAPEventType(exchange, soapRequest, soapResponse); + } + else { + return new HTTPEventType(exchange); + } + } + + /** + *+ * convenience method to convert the content of an HTTP request or response into a SOAP message + *
+ * + * @param content the content to be converted into a SOAP message + * + * @return the SOAP message contained in the content or null if either the content is null or + * the content does not contain a SOAP message + */ + private SOAPMessage getSOAPMessage(Content content) { + if ((content != null) && (content.getData() != null)) { + try { + if (soapMessageFactory == null) { + soapMessageFactory = MessageFactory.newInstance(); + } + + String encoding = content.getEncoding(); + if (encoding == null) { + encoding = "UTF-8"; + } + + InputStream in = new ByteArrayInputStream(content.getData().getBytes(encoding)); + return soapMessageFactory.createMessage(null, in); + } + catch (Exception e) { + if (content.getData().toLowerCase().indexOf("envelope") > 0) { + Console.traceln(Level.WARNING, "HTTP message seems to be a SOAP message but " + + "it could not be parsed as such: " + e); + Console.logException(e); + } + } + } + + return null; + } + + /** + ** returns the sequences parsed by this parser *
Index: /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/HTTPPlugin.java =================================================================== --- /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/HTTPPlugin.java (revision 1417) +++ /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/HTTPPlugin.java (revision 1417) @@ -0,0 +1,60 @@ +// Copyright 2012 Georg-August-Universität Göttingen, Germany +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package de.ugoe.cs.autoquest.plugin.http; + +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +import de.ugoe.cs.autoquest.plugin.AutoQUESTPlugin; + +/** + *+ * Identifier class for the AutoQUEST HTTP plug-in. + *
+ * + * @author Patrick Harms + * @version 1.0 + */ +public class HTTPPlugin implements AutoQUESTPlugin { + + /** + *+ * The command packages of this plug-in. + *
+ */ + private final static String[] commandPackages = new String[] + { "de.ugoe.cs.autoquest.plugin.http.commands" }; + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.AutoQUESTPlugin#getTitle() + */ + @Override + public String getTitle() { + return "HTTP-Plugin"; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.AutoQUESTPlugin#getCommandPackages() + */ + @Override + public List+ * compares two addresses and returns true, if they are equal and false else. The addresses + * are equal, if either the ip-addresses and the ports match or the host names and the + * ports match. + *
+ * + * @param address1 the first address to compare + * @param address2 the second address to compare + * + * @return as described + */ + public static boolean equals(Address address1, Address address2) { + if (address1 == null) { + return address2 == null; + } + else if (address2 == null) { + return false; + } + + if (!equals(address1.getPort(), address2.getPort())) { + return false; + } + + if (address1.getIp() != null) { + return equals(address1.getIp(), address2.getIp()); + } + else { + return equals(address1.getHost(), address2.getHost()); + } + } + /** + *+ * convenience method to compare to objects. They are considered equal if they both are null, + * or if their equals method returns true. + *
+ * + * @param object1 the first object to compare + * @param object2 the second object to compare + * + * @return as described + */ + public staticIndex: /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/HTTPEventType.java =================================================================== --- /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/HTTPEventType.java (revision 1416) +++ /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/HTTPEventType.java (revision 1417) @@ -17,4 +17,5 @@ import de.ugoe.cs.autoquest.eventcore.IEventType; import de.ugoe.cs.autoquest.httpmonitor.exchange.HttpExchange; +import de.ugoe.cs.autoquest.httpmonitor.exchange.HttpRequest; import de.ugoe.cs.autoquest.plugin.http.HTTPUtils; @@ -128,5 +129,23 @@ @Override public boolean equals(Object obj) { - return super.equals(obj); + if (this == obj) { + return true; + } + + if (obj instanceof HTTPEventType) { + HTTPEventType other = (HTTPEventType) obj; + + HttpRequest request1 = exchange.getRequest(); + HttpRequest request2 = other.exchange.getRequest(); + + return (HTTPUtils.equals(exchange.getSender(), other.exchange.getSender()) && + HTTPUtils.equals(exchange.getReceiver(), other.exchange.getReceiver()) && + HTTPUtils.equals(request1.getMethod(), request2.getMethod()) && + HTTPUtils.equals(request1.getProtocol(), request2.getProtocol()) && + HTTPUtils.equals(request1.getUrl(), request2.getUrl())); + } + else { + return false; + } } @@ -136,5 +155,8 @@ @Override public int hashCode() { - return super.hashCode(); + return + exchange.getRequest().getMethod().hashCode() + + exchange.getRequest().getProtocol().hashCode() + + exchange.getRequest().getUrl().hashCode(); } Index: /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/HTTPTarget.java =================================================================== --- /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/HTTPTarget.java (revision 1416) +++ /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/HTTPTarget.java (revision 1417) @@ -75,4 +75,12 @@ /* (non-Javadoc) + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + return stringIdentifier; + } + + /* (non-Javadoc) * @see java.lang.Object#equals(java.lang.Object) */ Index: /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/SOAPEventType.java =================================================================== --- /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/SOAPEventType.java (revision 1417) +++ /trunk/autoquest-plugin-http/src/main/java/de/ugoe/cs/autoquest/plugin/http/eventcore/SOAPEventType.java (revision 1417) @@ -0,0 +1,244 @@ +// Copyright 2012 Georg-August-Universität Göttingen, Germany +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package de.ugoe.cs.autoquest.plugin.http.eventcore; + +import java.net.MalformedURLException; +import java.net.URL; +import java.util.logging.Level; + +import javax.xml.soap.SOAPException; +import javax.xml.soap.SOAPMessage; + +import de.ugoe.cs.autoquest.httpmonitor.exchange.Header; +import de.ugoe.cs.autoquest.httpmonitor.exchange.HttpExchange; +import de.ugoe.cs.autoquest.plugin.http.HTTPUtils; +import de.ugoe.cs.util.console.Console; + +/** + *
+ * represents the specific HTTP event for a SOAP message exchange. It contains the SOAP request + * and response envelopes and is more concrete when comparing object. E.g., it considers the + * called SOAP operation on performing comparison. + *
+ * + * @author Patrick Harms + */ +public class SOAPEventType extends HTTPEventType { + + /** */ + private static final long serialVersionUID = 1L; + + /** + *+ * the SOAP request belonging to the event + *
+ */ + private SOAPMessage soapRequest; + + /** + *+ * the SOAP response belonging to the event + *
+ */ + private SOAPMessage soapResponse; + + /** + *+ * the SOAP method called in this request + *
+ */ + private String calledMethod; + + /** + *+ * the human readable name of this event type + *
+ */ + private String name; + + /** + *+ * initializes the event type with the represented HTTP exchange and the already extracted + * SOAP request and response. + *
+ * + * @param exchange the represented HTTP exchange + * @param soapRequest the already extracted SOAP request + * @param soapResponse the already extracted SOAP response + */ + public SOAPEventType(HttpExchange exchange, SOAPMessage soapRequest, SOAPMessage soapResponse) { + super(exchange); + this.soapRequest = soapRequest; + this.soapResponse = soapResponse; + this.calledMethod = determineCalledMethod(exchange, soapRequest); + + String path = null; + + if ((exchange.getRequest() != null) && (exchange.getRequest().getUrl() != null)) { + try { + path = new URL(exchange.getRequest().getUrl()).getPath(); + } + catch (MalformedURLException e) { + // ignore and continue + } + } + + StringBuffer nameBuffer = new StringBuffer("SOAPEvent"); + + boolean somethingAdded = false; + + if (path != null) { + nameBuffer.append("("); + nameBuffer.append(path); + somethingAdded = true; + } + + if (calledMethod != null) { + nameBuffer.append(somethingAdded ? ", " : "("); + nameBuffer.append(calledMethod); + somethingAdded = true; + } + + String senderStr = HTTPUtils.toString(exchange.getSender()); + String receiverStr = HTTPUtils.toString(exchange.getReceiver()); + + if ((senderStr != null) && (receiverStr != null)) { + nameBuffer.append(somethingAdded ? ", " : "("); + nameBuffer.append(senderStr); + nameBuffer.append(" --> "); + nameBuffer.append(receiverStr); + somethingAdded = true; + } + else if (senderStr != null) { + nameBuffer.append(somethingAdded ? ", " : "("); + nameBuffer.append(senderStr); + somethingAdded = true; + } + else if (receiverStr != null) { + nameBuffer.append(somethingAdded ? ", " : "("); + nameBuffer.append(receiverStr); + somethingAdded = true; + } + + if (somethingAdded) { + nameBuffer.append(")"); + } + + this.name = nameBuffer.toString(); + } + + /** + *+ * the SOAP method called in this request + *
+ * + * @return the SOAP method called in this request + */ + public String getCalledMethod() { + return calledMethod; + } + + /** + * @return the soapRequest + */ + public SOAPMessage getSoapRequest() { + return soapRequest; + } + + /** + * @return the soapResponse + */ + public SOAPMessage getSoapResponse() { + return soapResponse; + } + + /* (non-Javadoc) + * @see de.ugoe.cs.autoquest.eventcore.IEventType#getName() + */ + @Override + public String getName() { + return name; + } + + /* (non-Javadoc) + * @see de.ugoe.cs.autoquest.plugin.http.eventcore.HTTPEventType#toString() + */ + @Override + public String toString() { + return name; + } + + /* (non-Javadoc) + * @see de.ugoe.cs.autoquest.plugin.http.eventcore.HTTPEventType#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + else if (obj instanceof SOAPEventType) { + return + super.equals(obj) && + HTTPUtils.equals(calledMethod, ((SOAPEventType) obj).calledMethod); + } + else { + return false; + } + } + + /* (non-Javadoc) + * @see de.ugoe.cs.autoquest.plugin.http.eventcore.HTTPEventType#hashCode() + */ + @Override + public int hashCode() { + return super.hashCode() + calledMethod.hashCode(); + } + + /** + *+ * determines the name of the method called in a SOAP request either through the HTTP header + * or through the SOAP body + *
+ */ + private String determineCalledMethod(HttpExchange exchange, SOAPMessage soapRequest) { + // first check for a header containing the SOAP action + + if ((exchange.getRequest() != null) && (exchange.getRequest().getHeaders() != null) && + (exchange.getRequest().getHeaders().getHeader() != null)) + { + for (Header header : exchange.getRequest().getHeaders().getHeader()) { + if ("SOAPAction".equalsIgnoreCase(header.getKey())) { + return header.getValue(); + } + } + } + + // if there is none, use the root element of the body + try { + if ((soapRequest.getSOAPBody() != null) && + (soapRequest.getSOAPBody().getChildNodes() != null) && + (soapRequest.getSOAPBody().getChildNodes().getLength() > 0)) + { + return soapRequest.getSOAPBody().getChildNodes().item(0).getNodeName(); + } + } + catch (SOAPException e) { + Console.traceln(Level.WARNING, "could not process SOAP message correctly: " + e); + Console.logException(e); + } + + return null; + } +}