Home | History | Annotate | Download | only in vpn 
      1 /*
      2  * Copyright (C) 2009 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.android.settings.vpn;
     18 
     19 import android.app.Dialog;
     20 import android.net.vpn.VpnProfile;
     21 import android.view.View;
     22 
     23 /**
     24  * The interface to act on a {@link VpnProfile}.
     25  */
     26 public interface VpnProfileActor {
     27     VpnProfile getProfile();
     28 
     29     /**
     30      * Returns true if a connect dialog is needed before establishing a
     31      * connection.
     32      */
     33     boolean isConnectDialogNeeded();
     34 
     35     /**
     36      * Creates the view in the connect dialog.
     37      */
     38     View createConnectView();
     39 
     40     /**
     41      * Validates the inputs in the dialog.
     42      * @param dialog the connect dialog
     43      * @return an error message if the inputs are not valid
     44      */
     45     String validateInputs(Dialog dialog);
     46 
     47     /**
     48      * Establishes a VPN connection.
     49      * @param dialog the connect dialog
     50      */
     51     void connect(Dialog dialog);
     52 
     53     /**
     54      * Tears down the connection.
     55      */
     56     void disconnect();
     57 
     58     /**
     59      * Checks the current status. The result is expected to be broadcast.
     60      * Use {@link VpnManager#registerConnectivityReceiver()} to register a
     61      * broadcast receiver and to receives the broadcast events.
     62      */
     63     void checkStatus();
     64 }
     65