패키지 io.realm.mongodb.auth

클래스 ApiKeyAuth

  • public abstract class ApiKeyAuth
extends Object
    이 클래스는 사용자가 제어 하에 API 키를 managed 수 있는 기능을 노출합니다.

    • 메서드 세부 정보

      • getUser

        공개 사용자 getUser()
        이 인스턴스가 연결된 User 을 반환합니다.
        반환합니다:
        이 인스턴스가 연결된 User 입니다.

      • getApp

        공개 앱 getApp()
        이 인스턴스가 연결된 App 을 반환합니다.
        반환합니다:
        이 인스턴스가 연결된 App 입니다.

      • create

        public ApiKey create(문자열 이름)가 AppException을 발생시킵니다.
        사용자로 인증하는 데 사용할 수 있는 사용자 API 키를 생성합니다.

        키 값은 이때만 표시되므로 유지되어야 합니다.

        키는 생성되면 활성화됩니다. disable(ObjectId) 을(를) 호출하여 비활성화할 수 있습니다.

        매개변수:
        name - 키의 이름
        반환합니다:
        사용자를 위한 새 API 키입니다.
        예외 처리:
        AppException - 서버가 API 키 생성에 실패한 경우.

      • createAsync

        public RealmAsyncTask createAsync​(String name,
                                  App.Callback<ApiKey> callback)
        사용자로 인증하는 데 사용할 수 있는 사용자 API 키를 비동기적으로 생성합니다.

        키 값은 이때만 표시되므로 유지되어야 합니다.

        키는 생성되면 활성화됩니다. disable(ObjectId) 을(를) 호출하여 비활성화할 수 있습니다.

        매개변수:
        name - 키의 이름
        callback - 키 생성이 완료되거나 실패했을 때 콜백합니다. 콜백은 항상 이 메서드가 호출되는 동일한 스레드에서 발생합니다.
        예외 처리:
        IllegalStateException - 이벤트 루프가 아닌 스레드에서 호출된 경우.

      • 가져오기

        공개 ApiKey 가져오기(ObjectId id)로 인해 AppException이 발생합니다.
        사용자와 연결된 특정 사용자 API 키를 가져옵니다.
        매개변수:
        id - 가져올 키의 ID입니다.
        예외 처리:
        AppException - 서버가 API 키를 가져오지 못한 경우.

      • fetchAsync

        public RealmAsyncTask fetchAsync​(ObjectId id,
                                 App.Callback<ApiKey> callback)
        사용자와 연결된 특정 사용자 API 키를 가져옵니다.
        매개변수:
        id - 가져올 키의 ID입니다.
        callback - 키를 가져오거나 호출이 실패할 때 사용되는 콜백입니다. 콜백은 항상 이 메서드가 호출된 동일한 스레드에서 발생합니다.
        예외 처리:
        IllegalStateException - 이벤트 루프가 아닌 스레드에서 호출된 경우.

      • fetchAll

        public List<ApiKey> fetchAll()
                      throws AppException
        사용자와 연결된 모든 API 키를 가져옵니다.
        예외 처리:
        AppException - 서버가 API 키를 가져오지 못한 경우.

      • fetchAll

        public RealmAsyncTask fetchAll​(App.Callback<List<ApiKey>> callback)
        사용자와 연결된 모든 API 키를 가져옵니다.
        매개변수:
        callback - 키를 가져오거나 호출이 실패할 때 사용되는 콜백입니다. 콜백은 항상 이 메서드가 호출된 동일한 스레드에서 발생합니다.
        예외 처리:
        IllegalStateException - 이벤트 루프가 아닌 스레드에서 호출된 경우.

      • 삭제

        public void delete​(ObjectId id)
            throws AppException
        사용자가 생성한 특정 API 키를 삭제합니다.
        매개변수:
        id - 삭제할 키의 ID입니다.
        예외 처리:
        AppException - 서버가 API 키를 삭제하지 못한 경우.

      • deleteAsync

        public RealmAsyncTask deleteAsync​(ObjectId id,
                                  App.Callback<Void> callback)
        사용자가 생성한 특정 API 키를 삭제합니다.
        매개변수:
        id - 삭제할 키의 ID입니다.
        callback - 가 삭제되었거나 호출이 실패했을 때 사용되는 콜백입니다. 콜백은 항상 이 메서드가 호출된 동일한 스레드에서 발생합니다.
        예외 처리:
        IllegalStateException - 이벤트 루프가 아닌 스레드에서 호출된 경우.

      • 비활성화

        public void disable​(ObjectId id)
             throws AppException
        사용자가 생성한 특정 API 키를 비활성화합니다.
        매개변수:
        id - 비활성화할 키의 ID입니다.
        예외 처리:
        AppException - 서버가 API 키를 비활성화하지 못한 경우.

      • disableAsync

        public RealmAsyncTask disableAsync​(ObjectId id,
                                   App.Callback<Void> callback)
        사용자가 생성한 특정 API 키를 비활성화합니다.
        매개변수:
        id - 비활성화할 키의 ID입니다.
        callback - 키가 비활성화되었거나 호출이 실패했을 때 사용되는 콜백입니다. 콜백은 항상 이 메서드가 호출된 동일한 스레드에서 발생합니다.
        예외 처리:
        IllegalStateException - 이벤트 루프가 아닌 스레드에서 호출된 경우.

      • 활성화

        public void enable​(ObjectId id)
            throws AppException
        사용자가 생성한 특정 API 키를 활성화합니다.
        매개변수:
        id - 활성화할 키의 ID입니다.
        예외 처리:
        AppException - 서버가 API 키를 활성화하지 못한 경우.

      • enableAsync

        public RealmAsyncTask enableAsync​(ObjectId id,
                                  App.Callback<Void> callback)
        사용자가 생성한 특정 API 키를 활성화합니다.
        매개변수:
        id - 활성화할 키의 ID입니다.
        callback - 키가 활성화되었거나 호출이 실패했을 때 사용되는 콜백입니다. 콜백은 항상 이 메서드가 호출된 동일한 스레드에서 발생합니다.
        예외 처리:
        IllegalStateException - 이벤트 루프가 아닌 스레드에서 호출된 경우.

      • 해시 코드

        public int 해시 코드()
        재정의:
        hashCode 수업 중 Object