CXF WS, Interceptor: остановить обработку, ответить с ошибкой - PullRequest
6 голосов
/ 29 ноября 2011

Я ломаю голову над этим: используя перехватчик для проверки нескольких заголовков SOAP, как я могу прервать цепочку перехватчиков, но при этом ответить пользователю с ошибкой?

Работа с ошибкой работает в отношениивывод, но запрос все еще обрабатывается, и я бы предпочел, чтобы все службы не проверяли какой-либо флаг в контексте сообщения.

Прерывание с помощью «message.getInterceptorChain (). abort ();»действительно прерывает всю обработку, но затем клиенту ничего не возвращается.

Какой правильный путь?

public class HeadersInterceptor extends AbstractSoapInterceptor {

    public HeadersInterceptor() {
        super(Phase.PRE_LOGICAL);
    }

    @Override
    public void handleMessage(SoapMessage message) throws Fault {
        Exchange exchange = message.getExchange();
        BindingOperationInfo bop = exchange.getBindingOperationInfo();
        Method action = ((MethodDispatcher) exchange.get(Service.class)
                .get(MethodDispatcher.class.getName())).getMethod(bop);

        if (action.isAnnotationPresent(NeedsHeaders.class)
                && !headersPresent(message)) {
            Fault fault = new Fault(new Exception("No headers Exception"));
            fault.setFaultCode(new QName("Client"));

            try {
                Document doc = DocumentBuilderFactory.newInstance()
                        .newDocumentBuilder().newDocument();
                Element detail = doc.createElementNS(Soap12.SOAP_NAMESPACE, "mynamespace");
                detail.setTextContent("Missing some headers...blah");
                fault.setDetail(detail);

            } catch (ParserConfigurationException e) {
            }

            // bad: message.getInterceptorChain().abort();
            throw fault;
        }
    }
}

Ответы [ 3 ]

2 голосов
/ 11 декабря 2011

Следуя предложению Донал Феллоуз Я добавляю ответ на мой вопрос.

CXF сильно зависит от Spring AOP, который может вызывать любые проблемы, по крайней мере, здесь. Я предоставляю полный код для вас. Используя проекты с открытым исходным кодом, я думаю, что будет справедливо предоставить свои собственные несколько строк кода для тех, кто может решить не использовать WS-Security (я ожидаю, что мои службы будут работать только по SSL). Я написал большую часть этого, просматривая источники CXF.

Пожалуйста, прокомментируйте, если вы думаете, что есть лучший подход.

/**
 * Checks the requested action for AuthenticationRequired annotation and tries
 * to login using SOAP headers username/password.
 * 
 * @author Alexander Hofbauer
 */
public class AuthInterceptor extends AbstractSoapInterceptor {
    public static final String KEY_USER = "UserAuth";

    @Resource
    UserService userService;

    public AuthInterceptor() {
        // process after unmarshalling, so that method and header info are there
        super(Phase.PRE_LOGICAL);
    }

    @Override
    public void handleMessage(SoapMessage message) throws Fault {
        Logger.getLogger(AuthInterceptor.class).trace("Intercepting service call");

        Exchange exchange = message.getExchange();
        BindingOperationInfo bop = exchange.getBindingOperationInfo();
        Method action = ((MethodDispatcher) exchange.get(Service.class)
                .get(MethodDispatcher.class.getName())).getMethod(bop);

        if (action.isAnnotationPresent(AuthenticationRequired.class)
                && !authenticate(message)) {
            Fault fault = new Fault(new Exception("Authentication failed"));
            fault.setFaultCode(new QName("Client"));

            try {
                Document doc = DocumentBuilderFactory.newInstance()
                        .newDocumentBuilder().newDocument();
                Element detail = doc.createElementNS(Soap12.SOAP_NAMESPACE, "test");
                detail.setTextContent("Failed to authenticate.\n" +
                        "Please make sure to send correct SOAP headers username and password");
                fault.setDetail(detail);

            } catch (ParserConfigurationException e) {
            }

            throw fault;
        }
    }

    private boolean authenticate(SoapMessage msg) {
        Element usernameNode = null;
        Element passwordNode = null;

        for (Header header : msg.getHeaders()) {
            if (header.getName().getLocalPart().equals("username")) {
                usernameNode = (Element) header.getObject();
            } else if (header.getName().getLocalPart().equals("password")) {
                passwordNode = (Element) header.getObject();
            }
        }

        if (usernameNode == null || passwordNode == null) {
            return false;
        }
        String username = usernameNode.getChildNodes().item(0).getNodeValue();
        String password = passwordNode.getChildNodes().item(0).getNodeValue();

        User user = null;
        try {
            user = userService.loginUser(username, password);
        } catch (BusinessException e) {
            return false;
        }
        if (user == null) {
            return false;
        }

        msg.put(KEY_USER, user);
        return true;
    }
}

Как упомянуто выше, вот ExceptionHandler / -Logger. Сначала я не мог использовать его в сочетании с JAX-RS (также через CXF, JAX-WS теперь работает нормально). В любом случае, JAX-RS мне не нужен, так что проблема исчезла.

@Aspect
public class ExceptionHandler {
    @Resource
    private Map<String, Boolean> registeredExceptions;


    /**
     * Everything in my project.
     */
    @Pointcut("within(org.myproject..*)")
    void inScope() {
    }

    /**
     * Every single method.
     */
    @Pointcut("execution(* *(..))")
    void anyOperation() {
    }

    /**
     * Log every Throwable.
     * 
     * @param t
     */
    @AfterThrowing(pointcut = "inScope() && anyOperation()", throwing = "t")
    public void afterThrowing(Throwable t) {
        StackTraceElement[] trace = t.getStackTrace();
        Logger logger = Logger.getLogger(ExceptionHandler.class);

        String info;
        if (trace.length > 0) {
            info = trace[0].getClassName() + ":" + trace[0].getLineNumber()
                    + " threw " + t.getClass().getName();
        } else {
            info = "Caught throwable with empty stack trace";
        }
        logger.warn(info + "\n" + t.getMessage());
        logger.debug("Stacktrace", t);
    }

    /**
     * Handles all exceptions according to config file.
     * Unknown exceptions are always thrown, registered exceptions only if they
     * are set to true in config file.
     * 
     * @param pjp
     * @throws Throwable
     */
    @Around("inScope() && anyOperation()")
    public Object handleThrowing(ProceedingJoinPoint pjp) throws Throwable {
        try {
            Object ret = pjp.proceed();
            return ret;
        } catch (Throwable t) {
            // We don't care about unchecked Exceptions
            if (!(t instanceof Exception)) {
                return null;
            }

            Boolean throwIt = registeredExceptions.get(t.getClass().getName());
            if (throwIt == null || throwIt) {
                throw t;
            }
        }
        return null;
    }
}
1 голос
/ 06 февраля 2014

CXF позволяет вам указать, что ваш перехватчик идет до или после определенных перехватчиков. Если ваш перехватчик обрабатывает на входящей стороне (что на основании вашего описания имеет место), существует перехватчик, который называется CheckFaultInterceptor. Вы можете настроить свой перехватчик так, чтобы он шел до него:

public HeadersInterceptor(){
    super(Phase.PRE_LOGICAL);
    getBefore().add(CheckFaultInterceptor.class.getName());
}

Теоретически проверка перехватчика ошибок проверяет, произошла ли ошибка. Если он есть, он прерывает цепочку перехватчиков и вызывает цепочку обработчиков ошибок.

Я еще не смог протестировать это (оно полностью основано на доступной документации, с которой я столкнулся, пытаясь решить связанную проблему)

1 голос
/ 16 октября 2013

Короткий ответ, правильный способ прервать перехватчик на стороне клиента перед отправкой запроса - создать ошибку с исключением:

throw new Fault(
      new ClientException( // or any non-Fault exception, else blocks in
      // abstractClient.checkClientException() (waits for missing response code)
      "Error before sending the request"), Fault.FAULT_CODE_CLIENT);

Спасибо авторам постов за помощь в выяснении этого..

...