Package apple.networkextension

Class NEFilterControlProvider

  • All Implemented Interfaces:
    NSObject
    public class NEFilterControlProvider
extends NEFilterProvider
    [@interface] NEFilterControlProvider The NEFilterControlProvider class declares the programmatic interface for an object that is responsible for installing filtering rules on the device.

    • Constructor Detail

      • NEFilterControlProvider

        protected NEFilterControlProvider​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • URLAppendStringMap

        public NSDictionary<java.lang.String,​java.lang.String> URLAppendStringMap()
        [@property] URLAppendStringMap A dictionary containing strings to be appended to URLs.

      • handleNewFlowCompletionHandler

        public void handleNewFlowCompletionHandler​(NEFilterFlow flow,
                                           NEFilterControlProvider.Block_handleNewFlowCompletionHandler completionHandler)
        handleNewFlow:completionHandler: This function is called by the framework when the NEFilterDataProvider indicates that the filtering verdict for the given flow is NEFilterNewFlowVerdictNeedRules. Subclass implementations must override this method and implement whatever steps are necessary to fetch new rules pertaining to the given flow and place them on disk in a location accessible by the NEFilterDataProvider.
        Parameters:
        flow - An NEFilterFlow object containing details about the flow that requires a rules update.
        completionHandler - A block that must be called when the NEFilterControlProvider is ready for the NEFilterDataProvider to re-process the new flow. NEFilterControlVerdict stores the verdict through which the control provider determines if a flow needs to be dropped or allowed. The verdict also indicates if the control plugin wants the data plugin to update its rules and handle the verdict.

      • handleRemediationForFlowCompletionHandler

        public void handleRemediationForFlowCompletionHandler​(NEFilterFlow flow,
                                                      NEFilterControlProvider.Block_handleRemediationForFlowCompletionHandler completionHandler)
        handleRemediationForFlow:completionHandler: This function is called by the framework when the NEFilterDataProvider indicates that the filtering verdict for the given flow is NEFilterRemediateVerdictNeedRules. Subclass implementations must override this method and implement whatever steps are necessary to remediate the given flow.
        Parameters:
        flow - An NEFilterFlow object containing details about the flow that requires remediation.
        completionHandler - A block that must be called when the NEFilterControlProvider is ready for the NEFilterDataProvider to re-process the new flow. NEFilterControlVerdict stores the verdict through which the control provider determines if a flow needs to be dropped or allowed. The verdict also indicates if the control plugin wants the data plugin to update its rules and handle the verdict.

      • notifyRulesChanged

        public void notifyRulesChanged()
        notifyRulesChanged This function is called by filter control implementations to notify the data provider "out of band" that the rules changed.

      • remediationMap

        public NSDictionary<java.lang.String,​? extends NSDictionary<java.lang.String,​? extends NSObject>> remediationMap()
        * @property remediationMap * @discussion A dictionary containing custom strings to be inserted into the "content blocked" page displayed in WebKit. Each key in this dictionary corresponds to a string in the "content blocked" page. The value of each key is a dictionary that maps keys to the custom strings to be inserted into the "content blocked" page. The keys for the sub-dictionaries are defined by the control provider. When the data provider creates a "remediate" verdict using [NEFilterDataVerdict remediateVerdictWithRemediationURLMapKey:remediationButtonTextMapKey:], it passes the key corresponding to the custom string to be inserted into the "content blocked" page. Here is a sample remediationMap dictionary: remediationMap = @{ NEFilterProviderRemediationMapRemediationURLs :

      • setRemediationMap

        public void setRemediationMap​(NSDictionary<java.lang.String,​? extends NSDictionary<java.lang.String,​? extends NSObject>> value)
        * @property remediationMap * @discussion A dictionary containing custom strings to be inserted into the "content blocked" page displayed in WebKit. Each key in this dictionary corresponds to a string in the "content blocked" page. The value of each key is a dictionary that maps keys to the custom strings to be inserted into the "content blocked" page. The keys for the sub-dictionaries are defined by the control provider. When the data provider creates a "remediate" verdict using [NEFilterDataVerdict remediateVerdictWithRemediationURLMapKey:remediationButtonTextMapKey:], it passes the key corresponding to the custom string to be inserted into the "content blocked" page. Here is a sample remediationMap dictionary: remediationMap = @{ NEFilterProviderRemediationMapRemediationURLs :

      • setURLAppendStringMap

        public void setURLAppendStringMap​(NSDictionary<java.lang.String,​java.lang.String> value)
        [@property] URLAppendStringMap A dictionary containing strings to be appended to URLs.