패키지 io.realm.mongodb

클래스 AppConfiguration.Builder

java.lang.Object

io.realm.mongodb.AppConfiguration.Builder

클래스를 둘러싸는 경우:

AppConfiguration

public static class AppConfiguration.Builder
extends Object

AppConfiguration 의 인스턴스를 유창하게 구성하는 데 사용되는 빌더입니다.

생성자 요약

생성자

Constructor	설명
Builder(String appId)	AppConfiguration에 대한 빌더 인스턴스를 생성합니다.

메서드 요약

수정자 및 유형	메서드	설명
AppConfiguration.Builder	addCustomRequestHeader(String headerName, String headerValue)	Realm 객체 서버에 대한 모든 요청에 추가할 추가 HTTP 헤더를 추가합니다.
AppConfiguration.Builder	addCustomRequestHeaders(Map<String,String> headers)	Realm 객체 서버에 대한 모든 요청에 추가할 추가 HTTP headers를 추가합니다.
AppConfiguration.Builder	appName(String appName)	앱 이름을 설정합니다.
AppConfiguration.Builder	appVersion(String appVersion)	앱 버전을 설정합니다.
AppConfiguration.Builder	authorizationHeaderName(String headerName)	MongoDB Realm에 요청할 때 권한 부여 데이터를 전송하는 데 사용되는 HTTP 헤더의 이름을 설정합니다.
AppConfiguration.Builder	baseUrl(String baseUrl)	MongoDB Realm 애플리케이션의 기본 URL을 설정합니다.
AppConfiguration	build()	AppConfiguration을 만듭니다.
AppConfiguration.Builder	codecRegistry(CodecRegistry codecRegistry)	원격 Realm Functions 를 호출하고 원격 MongoDatabase 에 액세스할 때 BSON 인수와 결과를 인코딩 및 디코딩하는 데 사용되는 기본 코덱 레지스트리를 설정합니다.
AppConfiguration.Builder	defaultClientResetHandler(SyncSession.ClientResetHandler handler)	더 이상 사용되지 않습니다. 다음으로 대체됨 defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)
AppConfiguration.Builder	defaultSyncClientResetStrategy(DiscardUnsyncedChangesStrategy strategy)	동기화된 Realm이 클라이언트 재설정을 보고할 때 사용하는 기본 동기화 클라이언트 재설정 전략을 설정합니다.
AppConfiguration.Builder	defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy strategy)	동기화된 Realm이 클라이언트 재설정을 보고할 때 사용하는 기본 동기화 클라이언트 재설정 전략을 설정합니다.
AppConfiguration.Builder	defaultSyncErrorHandler(SyncSession.ErrorHandler errorHandler)	동기화된 Realms에서 세션 오류를 보고할 때 사용하는 기본 오류 핸들러를 설정합니다.
AppConfiguration.Builder	encryptionKey(byte[] key)	사용자 메타 데이터를 암호화하는 데만 사용되는 암호화 키를 설정합니다.
AppConfiguration.Builder	httpLogObfuscator(HttpLogObfuscator httpLogObfuscator)	HTTP 요청의 민감한 정보가 logcat에 표시되지 않도록 하는 데 사용되는 HttpLogObfuscator 를 설정합니다.
AppConfiguration.Builder	requestTimeout(long time, TimeUnit unit)	MongoDB Realm 애플리케이션에 대한 네트워크 요청에 사용되는 기본 시간 제한을 설정합니다.
AppConfiguration.Builder	syncRootDirectory(File rootDir)	기기와 MongoDB Realm 간에 데이터를 동기화할 때 사용되는 모든 파일과 Realm이 포함된 루트 폴더를 구성합니다.

클래스 java.lang에서 상속된 메소드입니다.객체

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

생성자 세부 정보

빌더

공개 빌더(문자열 appId)

AppConfiguration에 대한 빌더 인스턴스를 생성합니다.

매개변수:

appId - MongoDB Realm 애플리케이션의 애플리케이션 ID입니다.

메서드 세부 정보

encryptionKey

public AppConfiguration.Builder encryptionKey(@ParametersAreNonnullByDefault
                                              byte[] key)

사용자 메타 데이터를 암호화하는 데만 사용되는 암호화 키를 설정합니다. Individual Realms needs to use SyncConfiguration.Builder.encryptionKey(byte[]) to make them encrypted.

매개변수:

key - 64바이트 암호화 키.

예외 처리:

IllegalArgumentException - 키의 길이가 64바이트가 아닌 경우.

기본 URL

public AppConfiguration.Builder baseUrl(문자열 baseUrl)

MongoDB Realm 애플리케이션의 기본 URL을 설정합니다. 기본값은 AppConfiguration.DEFAULT_BASE_URL 입니다.

매개변수:

baseUrl - MongoDB Realm 애플리케이션의 기본 URL입니다.

앱 이름

public AppConfiguration.Builder appName(문자열 appName)

앱 이름을 설정합니다. 이는 MongoDB Realm 애플리케이션에서 네트워크 요청을 할 때 전송되는 디버그 헤더의 일부로만 사용됩니다.

매개변수:

appName - 애플리케이션을 식별하는 데 사용되는 앱 이름입니다.

appVersion

public AppConfiguration.Builder appVersion(문자열 appVersion)

앱 버전을 설정합니다. 이는 MongoDB Realm 애플리케이션에서 네트워크 요청을 할 때 전송되는 디버그 헤더의 일부로만 사용됩니다.

매개변수:

appVersion - 애플리케이션을 식별하는 데 사용되는 앱 버전입니다.

requestTimeout

public AppConfiguration.Builder requestTimeout(long time,
                                               TimeUnit 단위)

MongoDB Realm 애플리케이션에 대한 네트워크 요청에 사용되는 기본 시간 제한을 설정합니다. 이 제한을 초과하는 요청은 실패와 함께 종료됩니다. 기본값은 AppConfiguration.DEFAULT_REQUEST_TIMEOUT 초입니다.

매개변수:

time - 네트워크 요청에 대한 시간 초과 값입니다.

unit - 시간 초과를 정의하는 데 사용되는 시간 단위입니다.

권한 부여 헤더 이름

public AppConfiguration.Builder 권한 부여 헤더 이름(문자열 headerName)

MongoDB Realm에 요청할 때 권한 부여 데이터를 전송하는 데 사용되는 HTTP 헤더의 이름을 설정합니다. 사용자 지정 권한 부여 헤더를 예상하도록 MongoDB 서버 또는 방화벽이 구성되어 있어야 합니다.

기본 권한 부여 헤더의 이름은 AppConfiguration.DEFAULT_AUTHORIZATION_HEADER_NAME 입니다.

매개변수:

headerName - 헤더의 이름입니다.

예외 처리:

IllegalArgumentException - null 또는 빈 헤더가 제공된 경우.

addCustomRequestheader

public AppConfiguration.Builder addCustomRequest header(문자열 headerName,
                                                       문자열 headerValue)

Realm 객체 서버에 대한 모든 요청에 추가할 추가 HTTP 헤더를 추가합니다.

매개변수:

headerName - 헤더의 이름입니다.

headerValue - 헤더의 값입니다.

예외 처리:

IllegalArgumentException - 비어 있지 않은 headerName 가 제공되거나 null headerValue 인 경우.

addCustomRequestheaders

public AppConfiguration.Builder addCustomRequestHeaders(@Nullable
                                                        Map<String,String> headers)

Realm 객체 서버에 대한 모든 요청에 추가할 추가 HTTP headers를 추가합니다.

매개변수:

headers - (headerName, headerValue) 쌍의 맵입니다.

예외 처리:

IllegalArgumentException - 제공된 헤더 중 하나라도 불법적인 경우.

defaultSyncErrorHandler

public AppConfiguration.Builder defaultSyncErrorHandler(SyncSession.ErrorHandler ErrorHandler )

동기화된 Realms에서 세션 오류를 보고할 때 사용하는 기본 오류 핸들러를 설정합니다.

를 생성할 때 를 SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler) 호출하여 이 SyncConfiguration 기본값을 재정의할 수 있습니다.

매개변수:

errorHandler - 기본 오류 처리기입니다.

defaultClientResetHandler

@Deprecated
public AppConfiguration.Builder defaultClientResetHandler(SyncSession.ClientResetHandler 핸들러)

더 이상 사용되지 않습니다.

다음으로 대체됨 defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)

동기화된 Realm이 클라이언트 재설정을 보고할 때 사용하는 기본 클라이언트 재설정 핸들러를 설정합니다. 세션입니다.

를 생성할 때 를 SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler) 호출하여 이 SyncConfiguration 기본값을 재정의할 수 있습니다.

매개변수:

handler - 기본 클라이언트 재설정 처리기입니다.

defaultSyncClientResetStrategy

public AppConfiguration.Builder defaultSyncClientResetStrategy(@Nonnull
                                                               수동 복구UnsyncedChangesStrategy 전략)

동기화된 Realm이 클라이언트 재설정을 보고할 때 사용하는 기본 동기화 클라이언트 재설정 전략을 설정합니다. 세션입니다.

를 생성할 때 SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) 또는 SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) 를 호출하여 SyncConfiguration 이 기본값을 재정의할 수 있습니다.

매개변수:

strategy - 기본 동기화 클라이언트 재설정 전략입니다.

defaultSyncClientResetStrategy

public AppConfiguration.Builder defaultSyncClientResetStrategy(@Nonnull
                                                               DiscardUnsyncedChangesStrategy 전략)

동기화된 Realm이 클라이언트 재설정을 보고할 때 사용하는 기본 동기화 클라이언트 재설정 전략을 설정합니다. 세션입니다.

를 생성할 때 SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) 또는 SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) 를 호출하여 SyncConfiguration 이 기본값을 재정의할 수 있습니다.

매개변수:

strategy - 기본 동기화 클라이언트 재설정 전략입니다.

syncRootDirectory

public AppConfiguration.Builder syncRootDirectory(파일 rootDir)

기기와 MongoDB Realm 간에 데이터를 동기화할 때 사용되는 모든 파일과 Realm이 포함된 루트 폴더를 구성합니다.

기본 루트 디렉토리는 Context.getFilesDir()/mongodb-realm 입니다.

매개변수:

rootDir - 동기화 관련 파일을 저장할 위치입니다.

CodecRegistry

public AppConfiguration.Builder 코덱 레지스트리(CodecRegistry 코덱 레지스트리)

원격 Realm Functions 를 호출하고 원격 MongoDatabase 에 액세스할 때 BSON 인수와 결과를 인코딩 및 디코딩하는 데 사용되는 기본 코덱 레지스트리를 설정합니다.

지정하지 않으면 기본값은 AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY 입니다.

매개변수:

codecRegistry - 앱의 기본 코덱 레지스트리입니다.

다음도 참조하세요.

AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY, AppConfiguration.getDefaultCodecRegistry()

httpLogObfuscator

public AppConfiguration.Builder httpLogObfuscator(@Nullable
                                                  HttpLogObfuscator httpLogObfuscator)

HTTP 요청의 민감한 정보가 logcat에 표시되지 않도록 하는 데 사용되는 HttpLogObfuscator 를 설정합니다.

지정하지 않으면 기본적으로 HTTP 로그인 요청이 난독화됩니다.

매개변수:

httpLogObfuscator - 앱의 기본 HTTP 로그 난독화 도구입니다.

빌드

public AppConfiguration build()

AppConfiguration을 만듭니다.

반환합니다:

App 을(를) 생성하는 데 사용할 수 있는 AppConfiguration입니다.