Headwind MDM API Reference

Library capabilities

• Determine whether the application is running on the device managed by Headwind MDM
• Retrieve application settings from the server based on the device ID
• Send logs to the server (the logging rules are setup on the server based on the device ID)
• Get Push notifications sent by the server plugins

Class summary

• HeadwindMDM
• HeadwindMDM.EventHandler
• MDMError
• MDMException
• MDMPushHandler
• MDMPushMessage
• MDMService
• MDMService.ResultHandler
• MDMService.Log
• MDMService.Preferences

Sample code

Integration

To integrate the library into your Android application, you need:

1. Download the latest Headwind MDM library hmdm-X.X.X.aar on the project website and copy it to your project directory in the libs subdirectory
2. Add the following line to your build.gradle (module level):
   implementation files('libs/hmdm-1.1.3.aar')
   (replace the version number by the latest version).
3. Add the reference to the Headwind MDM package to the AndroidManifest.xml inside the <manifest> tag:

       <queries>
           <package android:name="com.hmdm.launcher" />
       </queries>  

HeadwindMDM

HeadwindMDM.EventHandler

MDMError

MDMException

MDMPushHandler

MDMPushMessage

MDMService

MDMService.ResultHandler

MDMService.Log

MDMService.Preferences

Sample code

Version 1.1.0 and above

To include Headwind MDM functions in your application, use the following code sample:

public class MainActivity extends AppCompatActivity implements HeadwindMDM.EventHandler {
    ...
    private HeadwindMDM headwindMDM;
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ...
        headwindMDM = HeadwindMDM.getInstance();
    }
 
    @Override
    protected void onResume() {
        super.onResume();
        ...
        if (!headwindMDM.isConnected()) {
            if (!headwindMDM.connect(this, this)) {
                // Your application is running outside Headwind MDM
            }
        } else {
            // Already connected, but settings may have changed
            // when our app was in the background, so reload them
            loadSettings();
        }
    }
 
    @Override
    protected void onDestroy() {
        headwindMDM.disconnect(this);
        super.onDestroy();
    }
 
    @Override
    public void onHeadwindMDMConnected() {
        // Connected to Headwind MDM, now you can load settings and use other MDM functions
        loadSettings();
    }
 
    @Override
    public void onHeadwindMDMDisconnected() {
    }
 
    @Override
    public void onHeadwindMDMConfigChanged() {
        // Settings were changed on the server, you need to reload them
        loadSettings();
    }

    // Get the application settings from the server
    private void loadSettings() {
        String someSetting = MDMService.Preferences.get("some_setting", getString(R.string.default_setting));
    }
}

Versions prior to 1.1.0

If you’re using a legacy version, you need to implement the reconnection after the connection interruption (for example after the update of Headwind MDM launcher).

To include Headwind MDM functions in your application, use the following code sample:

public class MainActivity extends AppCompatActivity implements MDMService.ResultHandler {
    ...
    private MDMService mdmService;
    private boolean mdmConnected = false;
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ...
        mdmService = MDMService.getInstance();
    }
 
    @Override
    protected void onResume() {
        super.onResume();
        ...
        if (mdmConnected) {
            // If we're already connected to Headwind MDM, load MDM settings and do other MDM related stuff here
            String someSetting = MDMService.Preferences.get("some_setting", getString(R.string.default_setting));
        } else {
            if (!mdmService.connect(this, this)) {
                // Failed to connect to Headwind MDM because the app is running outside MDM
            }
        }
    }
 
    @Override
    public void onMDMConnected() {
        mdmConnected = true;
        // Connected to Headwind MDM, now we can do MDM related stuff
        String someSetting = MDMService.Preferences.get("some_setting", getString(R.string.default_setting));
    }
 
    @Override
    public void onMDMDisconnected() {
        mdmConnected = false;
        // Reconnect in 5 sec (this could be after update or crash of Headwind MDM!)
        new Handler().postDelayed(new MDMReconnectRunnable(), 5000);
    }
 
    public class MDMReconnectRunnable implements Runnable {
        @Override
        public void run() {
            if (!mdmService.connect(MainActivity.this, MainActivity.this)) {
                // Retry in 1 minute
                new Handler().postDelayed(this, 60000);
            }
        }
    }
}