summaryrefslogtreecommitdiff
path: root/omapi/java
diff options
context:
space:
mode:
author Roshan Pius <rpius@google.com> 2023-03-10 13:31:55 -0800
committer Roshan Pius <rpius@google.com> 2023-09-21 21:22:31 -0700
commitd7a56a04359027a4abc90966b3dcc2cc737e8784 (patch)
tree9019d64284520a05b8b3613b798fb54f01f9e2c0 /omapi/java
parent51c5d5ede5c85823fdd127fddc67d56da0defed0 (diff)
se(api): Expose SEServiceManager to retrieve SE service
Similar to NfcServiceManager and other mainline module service classes. Bug: 263563609 Test: Compiles Change-Id: I3ad94afd403015e1fd23e5de53db559ad9840036
Diffstat (limited to 'omapi/java')
-rw-r--r--omapi/java/android/se/omapi/SeFrameworkInitializer.java70
-rw-r--r--omapi/java/android/se/omapi/SeServiceManager.java140
2 files changed, 210 insertions, 0 deletions
diff --git a/omapi/java/android/se/omapi/SeFrameworkInitializer.java b/omapi/java/android/se/omapi/SeFrameworkInitializer.java
new file mode 100644
index 000000000000..d09a35d85009
--- /dev/null
+++ b/omapi/java/android/se/omapi/SeFrameworkInitializer.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2023 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.se.omapi;
+
+import android.annotation.FlaggedApi;
+import android.annotation.NonNull;
+import android.annotation.Nullable;
+import android.annotation.SystemApi;
+import android.nfc.Flags;
+
+/**
+ * Class for performing registration for SE service.
+ *
+ * @hide
+ */
+@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
+@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+public class SeFrameworkInitializer {
+ private SeFrameworkInitializer() {}
+
+ private static volatile SeServiceManager sSeServiceManager;
+
+ /**
+ * Sets an instance of {@link SeServiceManager} that allows
+ * the se mainline module to register/obtain se binder services. This is called
+ * by the platform during the system initialization.
+ *
+ * @param seServiceManager instance of {@link SeServiceManager} that allows
+ * the se/nfc mainline module to register/obtain se binder services.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ public static void setSeServiceManager(
+ @NonNull SeServiceManager seServiceManager) {
+ if (sSeServiceManager != null) {
+ throw new IllegalStateException("setSeServiceManager called twice!");
+ }
+
+ if (seServiceManager == null) {
+ throw new IllegalArgumentException("seServiceManager must not be null");
+ }
+
+ sSeServiceManager = seServiceManager;
+ }
+
+ /**
+ * Gets an instance of {@link SeServiceManager} that allows
+ * the se mainline module to register/obtain se binder services.
+ *
+ * @return instance of {@link SeServiceManager} that allows
+ * the se/nfc mainline module to register/obtain se binder services.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ @Nullable
+ public static SeServiceManager getSeServiceManager() {
+ return sSeServiceManager;
+ }
+}
diff --git a/omapi/java/android/se/omapi/SeServiceManager.java b/omapi/java/android/se/omapi/SeServiceManager.java
new file mode 100644
index 000000000000..791073706752
--- /dev/null
+++ b/omapi/java/android/se/omapi/SeServiceManager.java
@@ -0,0 +1,140 @@
+/*
+ * Copyright 2023 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.
+ */
+
+
+/**********************************************************************
+ * This file is not a part of the SE mainline module *
+ * *******************************************************************/
+
+package android.se.omapi;
+
+import android.annotation.FlaggedApi;
+import android.annotation.NonNull;
+import android.annotation.Nullable;
+import android.annotation.SystemApi;
+import android.annotation.SystemApi.Client;
+import android.content.Context;
+import android.nfc.Flags;
+import android.os.IBinder;
+import android.os.ServiceManager;
+
+/**
+ * Provides a way to register and obtain the system service binder objects managed by the
+ * SecureElement service.
+ *
+ * @hide
+ */
+@SystemApi(client = Client.MODULE_LIBRARIES)
+@FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+public class SeServiceManager {
+
+ /**
+ * @hide
+ */
+ public SeServiceManager() {
+ }
+
+ /**
+ * A class that exposes the methods to register and obtain each system service.
+ * @hide
+ */
+ @SystemApi(client = Client.MODULE_LIBRARIES)
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ public static final class ServiceRegisterer {
+ private final String mServiceName;
+
+ /**
+ * @hide
+ */
+ public ServiceRegisterer(String serviceName) {
+ mServiceName = serviceName;
+ }
+
+ /**
+ * Register a system server binding object for a service.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ public void register(@NonNull IBinder service) {
+ ServiceManager.addService(mServiceName, service);
+ }
+
+ /**
+ * Get the system server binding object for a service.
+ *
+ * <p>This blocks until the service instance is ready,
+ * or a timeout happens, in which case it returns null.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ @Nullable
+ public IBinder get() {
+ return ServiceManager.getService(mServiceName);
+ }
+
+ /**
+ * Get the system server binding object for a service.
+ *
+ * <p>This blocks until the service instance is ready,
+ * or a timeout happens, in which case it throws {@link ServiceNotFoundException}.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ @NonNull
+ public IBinder getOrThrow() throws ServiceNotFoundException {
+ try {
+ return ServiceManager.getServiceOrThrow(mServiceName);
+ } catch (ServiceManager.ServiceNotFoundException e) {
+ throw new ServiceNotFoundException(mServiceName);
+ }
+ }
+
+ /**
+ * Get the system server binding object for a service. If the specified service is
+ * not available, it returns null.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ @Nullable
+ public IBinder tryGet() {
+ return ServiceManager.checkService(mServiceName);
+ }
+ }
+
+ /**
+ * See {@link ServiceRegisterer#getOrThrow}.
+ * @hide
+ */
+ @SystemApi(client = Client.MODULE_LIBRARIES)
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ public static class ServiceNotFoundException extends ServiceManager.ServiceNotFoundException {
+ /**
+ * Constructor.
+ *
+ * @param name the name of the binder service that cannot be found.
+ *
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ public ServiceNotFoundException(@NonNull String name) {
+ super(name);
+ }
+ }
+
+ /**
+ * Returns {@link ServiceRegisterer} for the "secure_element" service.
+ */
+ @FlaggedApi(Flags.FLAG_ENABLE_NFC_MAINLINE)
+ @NonNull
+ public ServiceRegisterer getSeManagerServiceRegisterer() {
+ return new ServiceRegisterer(Context.SECURE_ELEMENT_SERVICE);
+ }
+}