| /* |
| * Copyright 2019 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 android.media.tv.tuner.filter; |
| |
| import android.annotation.NonNull; |
| import android.annotation.RequiresPermission; |
| import android.annotation.Size; |
| import android.annotation.SystemApi; |
| import android.content.Context; |
| import android.media.tv.tuner.TunerUtils; |
| |
| /** |
| * Filter configuration for a IP filter. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public class IpFilterConfiguration extends FilterConfiguration { |
| private final byte[] mSrcIpAddress; |
| private final byte[] mDstIpAddress; |
| private final int mSrcPort; |
| private final int mDstPort; |
| private final boolean mPassthrough; |
| |
| private IpFilterConfiguration(Settings settings, byte[] srcAddr, byte[] dstAddr, int srcPort, |
| int dstPort, boolean passthrough) { |
| super(settings); |
| mSrcIpAddress = srcAddr; |
| mDstIpAddress = dstAddr; |
| mSrcPort = srcPort; |
| mDstPort = dstPort; |
| mPassthrough = passthrough; |
| } |
| |
| @Override |
| public int getType() { |
| return Filter.TYPE_IP; |
| } |
| |
| /** |
| * Gets source IP address. |
| */ |
| @Size(min = 4, max = 16) |
| @NonNull |
| public byte[] getSrcIpAddress() { |
| return mSrcIpAddress; |
| } |
| /** |
| * Gets destination IP address. |
| */ |
| @Size(min = 4, max = 16) |
| @NonNull |
| public byte[] getDstIpAddress() { |
| return mDstIpAddress; |
| } |
| /** |
| * Gets source port. |
| */ |
| public int getSrcPort() { |
| return mSrcPort; |
| } |
| /** |
| * Gets destination port. |
| */ |
| public int getDstPort() { |
| return mDstPort; |
| } |
| /** |
| * Checks whether the filter is passthrough. |
| * |
| * @return {@code true} if the data from IP subtype go to next filter directly; |
| * {@code false} otherwise. |
| */ |
| public boolean isPassthrough() { |
| return mPassthrough; |
| } |
| |
| /** |
| * Creates a builder for {@link IpFilterConfiguration}. |
| * |
| * @param context the context of the caller. |
| */ |
| @RequiresPermission(android.Manifest.permission.ACCESS_TV_TUNER) |
| @NonNull |
| public static Builder builder(@NonNull Context context) { |
| TunerUtils.checkTunerPermission(context); |
| return new Builder(); |
| } |
| |
| /** |
| * Builder for {@link IpFilterConfiguration}. |
| */ |
| public static class Builder extends FilterConfiguration.Builder<Builder> { |
| private byte[] mSrcIpAddress; |
| private byte[] mDstIpAddress; |
| private int mSrcPort; |
| private int mDstPort; |
| private boolean mPassthrough; |
| |
| private Builder() { |
| } |
| |
| /** |
| * Sets source IP address. |
| */ |
| @NonNull |
| public Builder setSrcIpAddress(@NonNull byte[] srcIpAddress) { |
| mSrcIpAddress = srcIpAddress; |
| return this; |
| } |
| /** |
| * Sets destination IP address. |
| */ |
| @NonNull |
| public Builder setDstIpAddress(@NonNull byte[] dstIpAddress) { |
| mDstIpAddress = dstIpAddress; |
| return this; |
| } |
| /** |
| * Sets source port. |
| */ |
| @NonNull |
| public Builder setSrcPort(int srcPort) { |
| mSrcPort = srcPort; |
| return this; |
| } |
| /** |
| * Sets destination port. |
| */ |
| @NonNull |
| public Builder setDstPort(int dstPort) { |
| mDstPort = dstPort; |
| return this; |
| } |
| /** |
| * Sets passthrough. |
| */ |
| @NonNull |
| public Builder setPassthrough(boolean passthrough) { |
| mPassthrough = passthrough; |
| return this; |
| } |
| |
| /** |
| * Builds a {@link IpFilterConfiguration} object. |
| */ |
| @NonNull |
| public IpFilterConfiguration build() { |
| int ipAddrLength = mSrcIpAddress.length; |
| if (ipAddrLength != mDstIpAddress.length || (ipAddrLength != 4 && ipAddrLength != 16)) { |
| throw new IllegalArgumentException( |
| "The lengths of src and dst IP address must be 4 or 16 and must be the same." |
| + "srcLength=" + ipAddrLength + ", dstLength=" + mDstIpAddress.length); |
| } |
| return new IpFilterConfiguration( |
| mSettings, mSrcIpAddress, mDstIpAddress, mSrcPort, mDstPort, mPassthrough); |
| } |
| |
| @Override |
| Builder self() { |
| return this; |
| } |
| } |
| } |