BeginInterceptor.java

/*
 * Copyright 2014 Jeanfrancois Arcand
 *
 * 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 org.atmosphere.stomp.interceptor;

import org.atmosphere.cpr.Action;
import org.atmosphere.cpr.AtmosphereFramework;
import org.atmosphere.cpr.AtmosphereInterceptorAdapter;
import org.atmosphere.stomp.StompInterceptor;
import org.atmosphere.stomp.protocol.Frame;

/**
 * <p>
 * Begins a transaction for the given {@link org.atmosphere.cpr.AtmosphereResource}.
 * </p>
 *
 * <p>
 * A transaction ID is generated that could be specified in future {@link org.atmosphere.stomp.protocol.Action#SEND}
 * to include their result in the transaction.
 * </p>
 *
 * <p>
 * In that case, all {@link SendInterceptor} operation results won't be dispatched by the {@link org.atmosphere.cpr.Broadcaster}
 * until the {@link org.atmosphere.cpr.AtmosphereResource} sends a commit frame for the associated transaction ID.
 * </p>
 *
 * @author Guillaume DROUET
 * @version 1.0
 * @since 0.2
 */
public class BeginInterceptor extends AtmosphereInterceptorAdapter implements StompInterceptor {

    /**
     * {@inheritDoc}
     */
    @Override
    public Action inspect(final AtmosphereFramework framework, final Frame frame, final FrameInterceptor.StompAtmosphereResource r) {
        final Action retval = inspect(r.getResource());

        return retval;
    }
}