com.android.ddmlib.jdwp.JdwpAgent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ddmlib Show documentation
Library providing APIs to talk to Android devices
There is a newer version: 25.3.0
/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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 com.android.ddmlib.jdwp;

import com.android.annotations.NonNull;
import com.android.annotations.Nullable;
import com.android.ddmlib.JdwpPacket;

import java.io.IOException;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

public abstract class JdwpAgent {

    /**
     * Interceptors waiting for a specific reply id.
     */
    @NonNull
    private final ConcurrentMap mReplyInterceptors;

    @NonNull
    private final List mInterceptors;

    @NonNull
    private final JdwpProtocol mProtocol;

    public JdwpAgent(@NonNull JdwpProtocol protocol) {
        mReplyInterceptors = new ConcurrentHashMap();
        mInterceptors = new LinkedList();
        mProtocol = protocol;
    }

    /**
     * Adds an interceptor for a specific reply id. Once this interceptor
     * handles the response, it will be removed.
     */
    protected void addReplyInterceptor(int id, @NonNull JdwpInterceptor interceptor) {
        mReplyInterceptors.put(id, interceptor);
    }

    /**
     * Removes, if present, the interceptor to handle a reply with the given id.
     */
    protected void removeReplyInterceptor(int id) {
        mReplyInterceptors.remove(id);
    }

    public void clear() {
        mReplyInterceptors.clear();
    }

    public void addJdwpInterceptor(@NonNull JdwpInterceptor interceptor) {
        mInterceptors.add(interceptor);
    }

    public void incoming(@NonNull JdwpPacket packet, @Nullable JdwpAgent target) throws IOException {
        mProtocol.incoming(packet, target);
        int id = packet.getId();
        if (packet.isReply()) {
            JdwpInterceptor interceptor = mReplyInterceptors.remove(id);
            if (interceptor != null) {
                packet = interceptor.intercept(this, packet);
            }
        }
        for (JdwpInterceptor interceptor : mInterceptors) {
            if (packet == null) break;
            packet = interceptor.intercept(this, packet);
        }

        if (target != null && packet != null) {
            target.send(packet);
        }
    }

    public void send(@NonNull JdwpPacket packet, @NonNull JdwpInterceptor interceptor) throws IOException {
        mReplyInterceptors.put(packet.getId(), interceptor);
        send(packet);
    }

    protected abstract void send(@NonNull JdwpPacket packet) throws IOException;

    @NonNull
    public JdwpProtocol getJdwpProtocol() {
        return mProtocol;
    }
}