com.sun.xml.ws.api.databinding.DatabindingFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webservices-rt Show documentation
This module contains the Metro runtime code.
There is a newer version: 4.0.4
/*
 * Copyright (c) 1997, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.api.databinding;

import java.util.Map;

/**
 * WsFactory is the entry point of all the ws-databinding APIs. A WsFactory
 * instance can be used to create WsTool, WsRuntime,
 * XsTool, and XsRuntime instances.
 * 
 *
 * 

 * Following is an example that creates a {@code WsTool} which provides the
 * operations for "WSDL to JAVA" and "JAVA to WSDL":

 *  *       WsFactory wsfac = WsFactory.newInstance();
 *       WsTool tool = wsfac.createTool();
 *       GenerationStatus status = tool.generateWsdl(javaToWsdkInfo);
 * 
 * 
 * 
 * 
 * Following is an example that creates a {@code WsRuntime} which provides the
 * operations to serialize/deserialize a JavaCallInfo to/from a SOAP message:

 *  *       WsFactory wsfac = WsFactory.newInstance();
 *       WsRuntime rt = wsfac.createRuntime(wsRuntimeConfig);
 * 
 * 
 * 
 * @see com.sun.xml.ws.api.databinding.Databinding
 * 
 * @author [email protected]
 */
public abstract class DatabindingFactory extends com.oracle.webservices.api.databinding.DatabindingFactory {

  /**
   * Creates a new instance of a WsTool. 
   * 
   * @return New instance of a WsTool
   */
//	abstract public WsTool createTool();

  /**
   * Creates a new instance of a WsRuntime which is initialized 
   * with the specified configuration object. 
   * 
   * @param config
   *          the EndpointRuntimeConfig to init this WsRuntime
   * @return New instance of a WsRuntime
   */
  abstract public com.oracle.webservices.api.databinding.Databinding createRuntime(DatabindingConfig config);
	
  /**
   * Creates a new instance of a XsTool. 
   * 
   * @return New instance of a XsTool
   */
//	abstract public XsTool createXsTool(String mode);

  /**
   * Creates a new instance of a XsRuntime. 
   * 
   * @return New instance of a XsRuntime
   */
//	abstract public XsRuntime createXsRuntime(String mode);

  /**
   * Access properties on the WsFactory instance.
   *
   * @return properties of this WsFactory
   */
	abstract public Map properties();

	/**
	 * The default implementation class name.
	 */
	static final String ImplClass = com.sun.xml.ws.db.DatabindingFactoryImpl.class.getName();

  /**
   * Create a new instance of a WsFactory. This static method 
   * creates a new factory instance.
   * 
   * Once an application has obtained a reference to a WsFactory 
   * it can use the factory to configure and obtain WsTool and
   * WsRuntime instances.
   * 
   * @return New instance of a WsFactory
   */
	static public DatabindingFactory newInstance() {
		try {
			Class cls = Class.forName(ImplClass);
			return (DatabindingFactory) cls.newInstance();
		} catch (Exception e) {
			e.printStackTrace();
		}
		return null;
	}
}