1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* 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.jboss.ws.core.jaxrpc;
// $Id: ParameterWrapping.java 4241 2007-08-07 19:17:32Z heiko.braun@jboss.com $
import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtField;
import javassist.CtNewMethod;
import javassist.LoaderClassPath;
import javassist.Modifier;
import javax.jws.soap.SOAPBinding.ParameterStyle;
import javax.xml.namespace.QName;
import org.jboss.logging.Logger;
import org.jboss.ws.WSException;
import org.jboss.ws.core.binding.TypeMappingImpl;
import org.jboss.ws.core.jaxrpc.binding.JBossXBDeserializerFactory;
import org.jboss.ws.core.jaxrpc.binding.JBossXBSerializerFactory;
import org.jboss.ws.core.soap.Style;
import org.jboss.ws.core.utils.HolderUtils;
import org.jboss.ws.metadata.umdm.EndpointMetaData;
import org.jboss.ws.metadata.umdm.OperationMetaData;
import org.jboss.ws.metadata.umdm.ParameterMetaData;
import org.jboss.ws.metadata.umdm.ServiceMetaData;
import org.jboss.ws.metadata.umdm.TypeMappingMetaData;
import org.jboss.ws.metadata.umdm.TypesMetaData;
import org.jboss.ws.metadata.umdm.WrappedParameter;
import org.jboss.wsf.common.JavaUtils;
/** A helper class to wrap/unwrap ducument style request/response structures.
*
* @author Thomas.Diesler@jboss.org
* @author <a href="mailto:jason.greene@jboss.com">Jason T. Greene</a>
* @since 06-Jun-2005
*/
public class ParameterWrapping
{
// provide logging
private static Logger log = Logger.getLogger(ParameterWrapping.class);
// This assertion should probably be moved somewhere earlier
private static void assertOperationMetaData(OperationMetaData opMetaData)
{
if (opMetaData.getStyle() != Style.DOCUMENT)
throw new WSException("Unexpected style: " + opMetaData.getStyle());
if (opMetaData.getParameterStyle() != ParameterStyle.WRAPPED)
throw new WSException("Unexpected parameter style: " + opMetaData.getParameterStyle());
}
private static Object holderValue(Object holder)
{
if (holder == null)
return null;
if (! HolderUtils.isHolderType(holder.getClass()))
return holder;
return HolderUtils.getHolderValue(holder);
}
public static Class getWrappedType(String variable, Class wrapperType)
{
try
{
PropertyDescriptor pd = new PropertyDescriptor(variable, wrapperType);
Method method = pd.getWriteMethod();
return method.getParameterTypes()[0];
}
catch (Exception ex)
{
if(log.isDebugEnabled()) log.debug("Invalid request wrapper: " + ex);
return null;
}
}
public static Object wrapRequestParameters(ParameterMetaData request, Object[] methodParams)
{
assertOperationMetaData(request.getOperationMetaData());
Class reqStructType = request.getJavaType();
if(log.isDebugEnabled()) log.debug("wrapRequestParameters: " + reqStructType.getName());
List<WrappedParameter> wrappedParameters = request.getWrappedParameters();
try
{
Object reqStruct = reqStructType.newInstance();
for (WrappedParameter param : wrappedParameters)
{
Object value = holderValue(methodParams[param.getIndex()]);
param.accessor().set(reqStruct, value);
}
return reqStruct;
}
catch (RuntimeException rte)
{
throw rte;
}
catch (Exception e)
{
throw new WSException("Cannot wrap request structure: " + e);
}
}
public static Map<Integer, Object> unwrapRequestParameters(ParameterMetaData request, Object reqStruct, Object[] methodParams)
{
OperationMetaData opMetaData = request.getOperationMetaData();
assertOperationMetaData(opMetaData);
if (reqStruct == null)
throw new IllegalArgumentException("Request struct cannot be null");
Class[] targetParameterTypes = opMetaData.getJavaMethod().getParameterTypes();
Map<Integer, Object> outParameters = new HashMap<Integer, Object>(targetParameterTypes.length);
List<WrappedParameter> wrappedParameters = request.getWrappedParameters();
Class reqStructType = reqStruct.getClass();
if(log.isDebugEnabled()) log.debug("unwrapRequestParameters: " + reqStructType.getName());
try
{
for (WrappedParameter param : wrappedParameters)
{
Class targetType = targetParameterTypes[param.getIndex()];
Object value = param.accessor().get(reqStruct);
// INOUT Parameter
if (HolderUtils.isHolderType(targetType))
{
value = HolderUtils.createHolderInstance(value, targetType);
outParameters.put(param.getIndex(), value);
}
methodParams[param.getIndex()] = value;
}
}
catch (RuntimeException rte)
{
throw rte;
}
catch (Exception e)
{
throw new IllegalArgumentException("Cannot unwrap request structure: " + e);
}
return outParameters;
}
public static Object wrapResponseParameters(ParameterMetaData returnMetaData, Object returnValue, Map<Integer, Object> outParameters)
{
assertOperationMetaData(returnMetaData.getOperationMetaData());
Class resStructType = returnMetaData.getJavaType();
if (returnValue != null && returnValue.getClass() == resStructType)
{
if(log.isDebugEnabled()) log.debug("Response parameter already wrapped" + resStructType.getName());
return returnValue;
}
if(log.isDebugEnabled()) log.debug("wrapResponseParameter: " + resStructType.getName());
List<WrappedParameter> wrappedParameters = returnMetaData.getWrappedParameters();
try
{
Object resStruct = resStructType.newInstance();
for (WrappedParameter param : wrappedParameters)
{
Object value = (param.getIndex() < 0) ? returnValue : holderValue(outParameters.get(param.getIndex()));
param.accessor().set(resStruct, value);
}
return resStruct;
}
catch (RuntimeException rte)
{
throw rte;
}
catch (Exception e)
{
throw new WSException("Cannot wrap response structure: " + e);
}
}
public static Object unwrapResponseParameters(ParameterMetaData retMetaData, Object resStruct, Object methodParams[])
{
OperationMetaData operationMetaData = retMetaData.getOperationMetaData();
assertOperationMetaData(operationMetaData);
Object retValue = null;
if (resStruct != null)
{
Class resStructType = resStruct.getClass();
if(log.isDebugEnabled()) log.debug("unwrapResponseParameter: " + resStructType.getName());
List<WrappedParameter> wrappedParameters = retMetaData.getWrappedParameters();
Class[] targetTypes = operationMetaData.getJavaMethod().getParameterTypes();
try
{
for (WrappedParameter param : wrappedParameters)
{
Object value = param.accessor().get(resStruct);
if (param.getIndex() < 0)
{
retValue = value;
}
else
{
Class targetType = targetTypes[param.getIndex()];
if (HolderUtils.isHolderType(targetType))
HolderUtils.setHolderValue(methodParams[param.getIndex()], value);
methodParams[param.getIndex()] = value;
}
}
}
catch (RuntimeException rte)
{
throw rte;
}
catch (Exception e)
{
throw new IllegalArgumentException("Cannot unwrap request structure: " + e);
}
}
return retValue;
}
/**
* This is just a dummy marker class used to identify a generated
* document/literal wrapped type
*
* @author <a href="mailto:jason.greene@jboss.com">Jason T. Greene</a>
* @version $Revision: 4241 $
*/
public static class WrapperType
{
}
/**
* Generates a wrapper type and assigns it to the passed ParameterMetaData
* object. This routine requires the pmd to contain completed wrappedTypes
* and wrappedVariables properties of the passed ParameterMetaData object.
*
* @param pmd a document/literal wrapped parameter
*/
public static void generateWrapper(ParameterMetaData pmd, boolean addTypeMapping)
{
List<WrappedParameter> wrappedParameters = pmd.getWrappedParameters();
OperationMetaData operationMetaData = pmd.getOperationMetaData();
EndpointMetaData endpointMetaData = operationMetaData.getEndpointMetaData();
ServiceMetaData serviceMetaData = endpointMetaData.getServiceMetaData();
ClassLoader loader = serviceMetaData.getUnifiedMetaData().getClassLoader();
if (operationMetaData.isDocumentWrapped() == false)
throw new WSException("Operation is not document/literal (wrapped)");
if (wrappedParameters == null)
throw new WSException("Cannot generate a type when their is no wrapped parameters");
String serviceName = serviceMetaData.getServiceName().getLocalPart();
String parameterName = pmd.getXmlName().getLocalPart();
String endpointName = endpointMetaData.getPortName().getLocalPart();
String packageName = endpointMetaData.getServiceEndpointInterface().getPackage().getName();
String wrapperName = packageName + "._JBossWS_" + serviceName + "_" + endpointName + "_" + parameterName;
if(log.isDebugEnabled()) log.debug("Generating wrapper: " + wrapperName);
Class wrapperType;
try
{
ClassPool pool = new ClassPool(true);
pool.appendClassPath(new LoaderClassPath(loader));
CtClass clazz = pool.makeClass(wrapperName);
clazz.setSuperclass(pool.get(WrapperType.class.getName()));
for (WrappedParameter param : wrappedParameters)
{
CtField field = new CtField(pool.get(param.getType()), param.getVariable(), clazz);
field.setModifiers(Modifier.PRIVATE);
clazz.addField(field);
clazz.addMethod(CtNewMethod.getter("get" + JavaUtils.capitalize(param.getVariable()), field));
clazz.addMethod(CtNewMethod.setter("set" + JavaUtils.capitalize(param.getVariable()), field));
}
wrapperType = (Class)pool.toClass(clazz, loader);
}
catch (Exception e)
{
throw new WSException("Could not generate wrapper type: " + wrapperName, e);
}
// Register type mapping if needed
if (addTypeMapping)
{
QName xmlType = pmd.getXmlType();
TypesMetaData typesMetaData = serviceMetaData.getTypesMetaData();
TypeMappingMetaData tmMetaData = new TypeMappingMetaData(typesMetaData, xmlType, wrapperName);
typesMetaData.addTypeMapping(tmMetaData);
TypeMappingImpl typeMapping = serviceMetaData.getTypeMapping();
typeMapping.register(wrapperType, xmlType, new JBossXBSerializerFactory(), new JBossXBDeserializerFactory());
}
pmd.setJavaTypeName(wrapperName);
}
}
|