com.sun.xml.ws.api.client.ServiceInterceptor Maven / Gradle / Ivy
Show all versions of webservices-osgi Show documentation
/*
* Copyright (c) 1997, 2022 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.client;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import com.sun.xml.ws.api.BindingID;
import com.sun.xml.ws.api.WSBinding;
import com.sun.xml.ws.api.WSFeatureList;
import com.sun.xml.ws.api.WSService;
import com.sun.xml.ws.developer.WSBindingProvider;
import jakarta.xml.ws.BindingProvider;
import jakarta.xml.ws.Dispatch;
import jakarta.xml.ws.WebServiceFeature;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Interception point for inner working of {@link WSService}.
*
*
* System-level code could hook an implementation of this to
* {@link WSService} to augument its behavior.
*
* @author Kohsuke Kawaguchi
* @since 2.1 EA3
* @see ServiceInterceptorFactory
*/
public abstract class ServiceInterceptor {
/**
* Default constructor.
*/
protected ServiceInterceptor() {}
/**
* Called before {@link WSBinding} is created, to allow interceptors
* to add {@link WebServiceFeature}s to the created {@link WSBinding}.
*
* @param port
* Information about the port for which dispatch/proxy will be created.
* @param serviceEndpointInterface
* Null if the created binding is for {@link Dispatch}. Otheriwse
* it represents the port interface of the proxy to be created.
* @param defaultFeatures
* The list of features that are currently scheduled to be set for
* the newly created {@link WSBinding}.
*
* @return
* A set of features to be added to the newly created {@link WSBinding}.
* Can be empty but never null.
* {@code defaultFeatures} will take precedence over what this method
* would return (because it includes user-specified ones which will
* take the at-most priority), but features you return from this method
* will take precedence over {@link BindingID}'s
* {@link BindingID#createBuiltinFeatureList() implicit features}.
*/
public List preCreateBinding(@NotNull WSPortInfo port, @Nullable Class serviceEndpointInterface, @NotNull WSFeatureList defaultFeatures) {
return Collections.emptyList();
}
/**
* A callback to notify the event of creation of proxy object for SEI endpoint. The
* callback could set some properties on the {@link BindingProvider}.
*
* @param bp created proxy instance
* @param serviceEndpointInterface SEI of the endpoint
*/
public void postCreateProxy(@NotNull WSBindingProvider bp,@NotNull Class serviceEndpointInterface) {
}
/**
* A callback to notify that a {@link Dispatch} object is created. The callback
* could set some properties on the {@link BindingProvider}.
*
* @param bp BindingProvider of dispatch object
*/
public void postCreateDispatch(@NotNull WSBindingProvider bp) {
}
/**
* Aggregates multiple interceptors into one facade.
*/
public static ServiceInterceptor aggregate(final ServiceInterceptor... interceptors) {
if(interceptors.length==1)
return interceptors[0];
return new ServiceInterceptor() {
@Override
public List preCreateBinding(@NotNull WSPortInfo port, @Nullable Class portInterface, @NotNull WSFeatureList defaultFeatures) {
List r = new ArrayList<>();
for (ServiceInterceptor si : interceptors)
r.addAll(si.preCreateBinding(port,portInterface,defaultFeatures));
return r;
}
@Override
public void postCreateProxy(@NotNull WSBindingProvider bp, @NotNull Class serviceEndpointInterface) {
for (ServiceInterceptor si : interceptors)
si.postCreateProxy(bp,serviceEndpointInterface);
}
@Override
public void postCreateDispatch(@NotNull WSBindingProvider bp) {
for (ServiceInterceptor si : interceptors)
si.postCreateDispatch(bp);
}
};
}
}