RpcServer (p4java 2023.2.2581742 API)

java.lang.Object
- com.perforce.p4java.server.HelixCommandExecutor
- - com.perforce.p4java.impl.mapbased.server.Server
  - - com.perforce.p4java.impl.mapbased.rpc.RpcServer

All Implemented Interfaces:

IListDelegator, IServerControl, IAttributeDelegator, IBranchDelegator, IBranchesDelegator, IChangeDelegator, IChangesDelegator, IClientDelegator, IClientsDelegator, ICommitDelegator, IConfigureDelegator, ICounterDelegator, ICountersDelegator, IDBSchemaDelegator, IDepotDelegator, IDepotsDelegator, IDescribeDelegator, IDiff2Delegator, IDirsDelegator, IDiskspaceDelegator, IDuplicateDelegator, IExportDelegator, IExtensionDelegator, IFileAnnotateDelegator, IFileLogDelegator, IFilesDelegator, IFixDelegator, IFixesDelegator, IFstatDelegator, IGraphCommitLogDelegator, IGraphListTreeDelegator, IGraphReceivePackDelegator, IGraphRevListDelegator, IGraphShowRefDelegator, IGrepDelegator, IGroupDelegator, IGroupsDelegator, IInfoDelegator, IIntegratedDelegator, IInterchangesDelegator, IJobDelegator, IJobsDelegator, IJobSpecDelegator, IJournalWaitDelegator, IKeyDelegator, IKeysDelegator, ILabelDelegator, ILabelsDelegator, ILicenseDelegator, ILogin2Delegator, ILoginDelegator, ILogoutDelegator, ILogTailDelegator, IMonitorDelegator, IMoveDelegator, IObliterateDelegator, IOpenedDelegator, IPasswdDelegator, IPrintDelegator, IPropertyDelegator, IProtectDelegator, IProtectsDelegator, IReloadDelegator, IRenameClientDelegator, IRenameUserDelegator, IReposDelegator, IReviewDelegator, IReviewsDelegator, ISearchDelegator, ISizesDelegator, ISpecDelegator, IStatDelegator, IStreamDelegator, IStreamlogDelegator, IStreamsDelegator, ITagDelegator, ITriggersDelegator, IUnloadDelegator, IUserDelegator, IUsersDelegator, IVerifyDelegator, IHelixCommandExecutor, IOptionsServer, IServer

Direct Known Subclasses:

NtsServerImpl, OneShotServerImpl
```
public abstract class RpcServer
extends Server
```
RPC-based Perforce server implementation superclass.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`applicationName`
`protected RpcUserAuthCounter`	`authCounter`
`protected long`	`authFileLockDelay`
`protected int`	`authFileLockTry`
`protected long`	`authFileLockWait`
`protected int`	`clientApiLevel`
`protected ClientTrust`	`clientTrust`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`cmdMapArgs` The RPC command args before the function name (i.e.
`protected long`	`connectionStart`
`static int`	`DEFAULT_CLIENT_API_LEVEL` Default Perforce client API level; 81 represents 2016.2 capabilities.
`static java.lang.String`	`DEFAULT_PROG_NAME` The default string sent to the Perforce server in the protocol command defining the client's program name.
`static java.lang.String`	`DEFAULT_PROG_VERSION` The default string sent to the Perforce server in the protocol command defining the client's program version.
`static int`	`DEFAULT_SERVER_API_LEVEL` Default Perforce server API level; 99999 apparently means "whatever...".
`static IServerImplMetadata.ImplType`	`IMPL_TYPE` The implementation type of this implementation.
`protected java.lang.String`	`localHostName`
`protected java.util.Map<java.lang.String,java.lang.String>`	`pBufs`
`protected boolean`	`relaxCmdNameValidationChecks` If true, relax the command name validation checks done in the RPC layer.
`static java.lang.String`	`RPC_BYTE_BUFFER_OUTPUT_KEY`
`static boolean`	`RPC_ENABLE_STREAMS` Signifies whether or not the client is capable of handling streams.
`static java.lang.String`	`RPC_ENV_CWD_KEY` The system properties key for the JVM's current directory.
`static java.lang.String`	`RPC_ENV_NOCLIENT_SPEC` What we use in the RPC environment packet to signal to the Perforce server that we don't have a client set yet or don't know what it is.
`static java.lang.String`	`RPC_ENV_NOHOST_SPEC` What we use in the RPC environment packet to signal to the Perforce server that we don't have a hostname set yet or don't know what it is.
`static java.lang.String`	`RPC_ENV_NOUSER_SPEC` What we use in the RPC environment packet to signal to the Perforce server that we don't have a client set yet or don't know what it is.
`static java.lang.String`	`RPC_ENV_OS_NAME_KEY` The system properties key for the OS name.
`static java.lang.String`	`RPC_ENV_UNIX_SPEC` What we use in the RPC environment packet to signal to the Perforce server that we're a NON-Windows box.
`static java.lang.String`	`RPC_ENV_WINDOWS_PREFIX` RPC_ENV_OS_NAME_KEY property value prefix for Windows systems.
`static java.lang.String`	`RPC_ENV_WINDOWS_SPEC` What we use in the RPC environment packet to signal to the Perforce server that we're a Windows box.
`static boolean`	`RPC_TAGS_USED` Signifies whether or not we use tagged output.
`static java.lang.String`	`RPC_TMP_CONVERTER_KEY` Use to key converter to use out of state map
`static java.lang.String`	`RPC_TMP_OUTFILE_STREAM_KEY` Used to key temporary output streams in the command environment's state map for things like getFileContents(), etc., using the execStreamCmd method(s).
`protected IServerAddress`	`rpcServerAddress`
`protected java.util.Map<java.lang.String,java.lang.String>`	`secretKeys`
`protected int`	`serverApiLevel`
`protected java.lang.String`	`serverId`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`serverProtocolMap`
`protected ServerStats`	`serverStats`
`protected java.lang.String`	`ticketsFilePath`
`static java.lang.String`	`TRACE_PREFIX` What we use as a P4JTracer trace prefix for methods here.
`protected java.lang.String`	`trustFilePath`
`protected boolean`	`validatedByChain`
`protected boolean`	`validatedByFingerprint`
`protected boolean`	`validatedByHostname`

Fields inherited from class com.perforce.p4java.impl.mapbased.server.Server
authTickets, browserCallback, browserVersion, caseSensitive, charsetName, client, clientName, clientPath, clientUnsetName, commandCallback, connected, CORE_AUTH_FAIL_STRING_1, CORE_AUTH_FAIL_STRING_2, CORE_AUTH_FAIL_STRING_3, CORE_AUTH_FAIL_STRING_4, DEFAULT_STATUS_FIELD_NAME, enableAndmaps, enableGraph, enableProgress, enableStreams, enableTracking, ignoreFileName, IMPL_COMMENTS_FIELD_NAME, IMPL_TYPE_FIELD_NAME, loginOnConnect, MINIMUM_SUPPORTED_SERVER_LEVEL_FIELD_NAME, minimumSupportedServerVersion, nextCmdCallBackKey, nextProgressCallbackKey, nonCheckedSyncs, p4Charset, P4IGNORE_ENV_VAR, P4TICKETS_DEFAULT_OTHER, P4TICKETS_DEFAULT_WINDOWS, P4TICKETS_ENV_VAR, P4TRUST_DEFAULT_OTHER, P4TRUST_DEFAULT_WINDOWS, P4TRUST_ENV_VAR, password, progressCallback, props, PROTOCOL_NAME_FIELD_NAME, quietMode, rand, rsh, runningOnWindows, SCREEN_NAME_FIELD_NAME, secure, serverAddress, serverHost, serverInfo, serverPort, serverProtocol, serverVersion, setupOnConnect, ssoCallback, ssoKey, status, tmpDirName, UNKNOWN_SERVER_HOST, UNKNOWN_SERVER_PORT, UNKNOWN_SERVER_VERSION, usageOptions, useAuthMemoryStore, userName

Fields inherited from interface com.perforce.p4java.server.IServer
ATTRIBUTE_STREAM_MAP_KEY, IN_MAP_USE_TAGS_KEY

Constructor Summary

Constructors
Constructor and Description

RpcServer()

Constructors
Constructor and Description
`RpcServer()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`addTrust(java.lang.String fingerprintValue)` Approve and add the specified fingerprint for the Perforce SSL connection.
`java.lang.String`	`addTrust(java.lang.String fingerprintValue, TrustOptions options)` Approve and add the specified fingerprint or replacement for the Perforce SSL connection.
`java.lang.String`	`addTrust(TrustOptions opts)` Approve and add the fingerprint for the Perforce SSL connection.
`protected void`	`checkFingerprint(RpcConnection rpcConnection)` Check the fingerprint of the Perforce server SSL connection
`protected java.lang.String`	`composeAuthTicketEntryKey(java.lang.String userName, java.lang.String serverAddress)` Compose the key for an auth ticket entry
`void`	`connect()` Try to establish an actual RPC connection to the target Perforce server.
`void`	`disconnect()` Try to cleanly disconnect from the Perforce server at the other end of the current connection (with the emphasis on "cleanly").
`java.lang.String`	`getApplicationName()`
`RpcUserAuthCounter`	`getAuthCounter()` Get the RPC user authentication counter.
`java.lang.String`	`getAuthId()` Return the Perforce Server's authId.
`java.lang.String`	`getAuthTicket(java.lang.String userName)` Deprecated. use `getAuthTicket(String, String)`
`java.lang.String`	`getAuthTicket(java.lang.String userName, java.lang.String serverId)` Return the Perforce authentication ticket for specified user.
`int`	`getClientApiLevel()`
`java.nio.charset.Charset`	`getClientCharset()`
`protected java.lang.String`	`getClientNameForEnv()`
`java.lang.String`	`getErrorOrInfoStr(java.util.Map<java.lang.String,java.lang.Object> map)` Deprecated. use `ResultMapParser.getErrorOrInfoStr(Map)`
`java.lang.String`	`getErrorStr(java.util.Map<java.lang.String,java.lang.Object> map)` Deprecated. use `ResultMapParser.getErrorStr(Map)`
`int`	`getGenericCode(java.util.Map<java.lang.String,java.lang.Object> map)`
`protected java.lang.String`	`getHostForEnv()`
`java.lang.String`	`getInfoStr(java.util.Map<java.lang.String,java.lang.Object> map)` Deprecated. use `ResultMapParser.getInfoStr(Map)`
`protected java.lang.String`	`getLanguageForEnv()`
`protected java.lang.String`	`getOsTypeForEnv()`
`java.lang.String`	`getPBuf(java.lang.String userName)`
`PerformanceMonitor`	`getPerfMonitor()`
`protected RpcPacketFieldRule`	`getRpcPacketFieldRule(java.util.Map<java.lang.String,java.lang.Object> inMap, CmdSpec cmdSpec)` Get the RPC packet field rule for skipping the charset conversion of a range of RPC packet fields; leave the values as bytes.
`IServerAddress`	`getRpcServerAddress()` Get the server's address for the RPC connection.
`java.lang.String`	`getSecretKey()`
`java.lang.String`	`getSecretKey(java.lang.String userName)`
`java.lang.String`	`getServerAddress()` Get the server's address field used for storing authentication tickets.
`java.lang.String`	`getServerHostPort()` Get the server's host and port used for the RPC connection.
`java.lang.String`	`getServerId()` Get the server's id field used for storing authentication tickets.
`int`	`getSeverityCode(java.util.Map<java.lang.String,java.lang.Object> map)`
`java.lang.String`	`getTicketsFilePath()` Return the Perforce authentication tickets file path.
`java.lang.String`	`getTrust()` Return the fingerprint for the Perforce SSL connection.
`java.lang.String`	`getTrustFilePath()` Return the Perforce trust file path.
`java.util.List<Fingerprint>`	`getTrusts()` List all fingerprints in the trust file.
`java.util.List<Fingerprint>`	`getTrusts(TrustOptions opts)` List all fingerprints or replacements in the trust file.
`protected java.lang.String`	`getUserForEnv()`
`ServerStatus`	`init(java.lang.String host, int port, java.util.Properties props)` The default init sets up things like host names, etc., and fails if we can't establish some pretty basic things at connect time.
`ServerStatus`	`init(java.lang.String host, int port, java.util.Properties props, UsageOptions opts)` Convenience method for init(host, port, props, opts, secure).
`ServerStatus`	`init(java.lang.String host, int port, java.util.Properties properties, UsageOptions opts, boolean secure)` Convenience method for init(host, port, props, opts, secure, null).
`boolean`	`isAuthFail(java.lang.String errStr)` Deprecated. use `ResultMapParser.isAuthFail(String)`
`boolean`	`isInfoMessage(java.util.Map<java.lang.String,java.lang.Object> map)` Deprecated. use `ResultMapParser.isInfoMessage(Map)`
`boolean`	`isLoginNotRequired(java.lang.String msgStr)`
`protected boolean`	`isRelaxCmdNameValidationChecks()`
`boolean`	`isServerUnicode()`
`boolean`	`isValidatedByChain()` was the server ssl connection validated by chain?
`boolean`	`isValidatedByFingerprint()` was the server ssl connection validated by fingerprint?
`boolean`	`isValidatedByHostname()` was the server ssl connection validated by hostname match?
`Fingerprint`	`loadFingerprint(java.lang.String serverKey, java.lang.String fingerprintUser)` Get the p4trust entry value for the server IP and port based upon a search of either the file found at `PropertyDefs.TRUST_PATH_KEY_SHORT_FORM`, `PropertyDefs.TRUST_PATH_KEY`, the P4TRUST environment variable or the standard p4trust file location for the current OS.
`Fingerprint[]`	`loadFingerprints()` Get the p4trust entries from the file found at `PropertyDefs.TRUST_PATH_KEY_SHORT_FORM`, `PropertyDefs.TRUST_PATH_KEY`, the P4TRUST environment variable or the standard p4trust file location for the current OS.
`java.lang.String`	`loadTicket(java.lang.String serverId)` Get the p4tickets entry value for the current user returned from `Server.getUserName()` and server address based upon a search of either the file found at `PropertyDefs.TICKET_PATH_KEY_SHORT_FORM`, `PropertyDefs.TICKET_PATH_KEY`, the P4TICKETS environment variable or the standard p4tickets file location for the current OS.
`java.lang.String`	`loadTicket(java.lang.String serverId, java.lang.String name)` Get the p4tickets entry value for the specified user and server address based upon a search of either the file found at `PropertyDefs.TICKET_PATH_KEY_SHORT_FORM`, `PropertyDefs.TICKET_PATH_KEY`, the P4TICKETS environment variable or the standard p4tickets file location for the current OS.
`protected void`	`processCmdCallbacks(int cmdCallBackKey, long timeTaken, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> resultMaps)`
`java.lang.String`	`removeTrust()` Remove the fingerprint for the Perforce SSL connection.
`java.lang.String`	`removeTrust(TrustOptions opts)` Remove the fingerprint or replacement for the Perforce SSL connection.
`void`	`saveCurrentTicket()` Deprecated. use `saveTicket(String, String, String)`
`void`	`saveFingerprint(java.lang.String serverIpPort, java.lang.String fingerprintUser, java.lang.String fingerprintValue)` Save specified fingerprint value as associate with this server's address.
`void`	`saveTicket(java.lang.String ticketValue)` Deprecated. use `saveTicket(String, String, String)`
`void`	`saveTicket(java.lang.String userName, java.lang.String serverId, java.lang.String ticketValue)` Save specified auth ticket value as associate with this server's address and user name from the userName parameter.
`void`	`setApplicationName(java.lang.String applicationName)`
`void`	`setAuthTicket(java.lang.String userName, java.lang.String authTicket)` Deprecated. use `setAuthTicket(String, String, String)`
`void`	`setAuthTicket(java.lang.String userName, java.lang.String serverId, java.lang.String authTicket)` Set the server's Perforce authentication ticket for the specified user to the passed-in string.
`void`	`setClientApiLevel(int clientApiLevel)`
`void`	`setPbuf(java.lang.String userName, java.lang.String pBuf)`
`void`	`setPerfMonitor(PerformanceMonitor perfMonitor)`
`protected void`	`setRelaxCmdNameValidationChecks(boolean relaxCmdNameValidationChecks)`
`void`	`setRpcServerAddress(IServerAddress rpcServerAddress)` Set the server's address for the RPC connection.
`void`	`setSecretKey(java.lang.String secretKey)`
`void`	`setSecretKey(java.lang.String userName, java.lang.String secretKey)`
`void`	`setServerId(java.lang.String serverId)` Set the server's id field used for storing authentication tickets.
`void`	`setTicketsFilePath(java.lang.String ticketsFilePath)` Set the Perforce authentication tickets file path.
`void`	`setTrustFilePath(java.lang.String trustFilePath)` Set the Perforce trust file path.
`boolean`	`supportsSmartMove()` Return true IFF the underlying Perforce server supports the new 2009.1 and later "smart move" command.
`void`	`trustConnectionCheck(RpcConnection rpcConnection)` Check Server Trust
`protected boolean`	`useTags(java.lang.String cmdName, java.lang.String[] cmdArgs, java.util.Map<java.lang.String,java.lang.Object> inMap, boolean isStreamCmd)` Allow for per-command use of tags or not.
`protected boolean`	`writeInPlace(java.lang.String cmdName)` Return true if we should be performing server -> client file write I/O operations in place for this command.

Methods inherited from class com.perforce.p4java.impl.mapbased.server.Server
changePassword, createBranchSpec, createClient, createDepot, createExtensionConfig, createJob, createLabel, createProtectionEntries, createStream, createTempClient, createTriggerEntries, createUser, createUser, createUserGroup, createUserGroup, deleteBranchSpec, deleteBranchSpec, deleteClient, deleteClient, deleteCounter, deleteDepot, deleteExtension, deleteJob, deleteKey, deleteLabel, deleteLabel, deletePendingChangelist, deletePendingChangelist, deleteProperty, deleteStream, deleteUser, deleteUser, deleteUserGroup, deleteUserGroup, doGraphReceivePack, duplicateRevisions, fixJobs, fixJobs, getAuthTicket, getBlobObject, getBranchSpec, getBranchSpec, getBranchSpecs, getBranchSpecs, getBrowserCallback, getChangelist, getChangelist, getChangelistDiffs, getChangelistDiffs, getChangelistDiffsStream, getChangelistExtendedFiles, getChangelistExtendedFiles, getChangelistFiles, getChangelistFiles, getChangelists, getChangelists, getChangelists, getCharsetName, getClient, getClient, getClientName, getClientPath, getClients, getClients, getClientTemplate, getClientTemplate, getClientTemplate, getCommitFiles, getCommitObject, getCommitObject, getCounter, getCounter, getCounters, getCounters, getCounters, getCurrentClient, getCurrentServerInfo, getDbSchema, getDefaultP4TicketsFile, getDefaultP4TrustFile, getDepot, getDepotFiles, getDepotFiles, getDepots, getDepots, getDirectories, getDirectories, getDiskSpace, getExportRecords, getExportRecords, getExtendedFiles, getExtendedFiles, getExtensionConfig, getFileAnnotations, getFileAnnotations, getFileContents, getFileContents, getFileContents, getFileDiffs, getFileDiffs, getFileDiffsStream, getFileSizes, getFixes, getFixList, getGraphCommitLogList, getGraphListTree, getGraphObject, getGraphRevList, getGraphShowRefs, getIgnoreFileName, getInfoServerAddress, getInterchanges, getInterchanges, getInterchanges, getInterchanges, getJob, getJobs, getJobs, getJobSpec, getKey, getKeys, getKnownCharsets, getLabel, getLabels, getLabels, getLicense, getLimits, getListData, getListData, getLogin2Status, getLogin2Status, getLoginStatus, getLogTail, getMatchingLines, getMatchingLines, getOpenedFiles, getOpenedFiles, getPreferredPathArray, getPreferredPathArray, getProperties, getProperty, getProtectionEntries, getProtectionEntries, getProtectionsTable, getRandomInt, getRepos, getRepos, getRepos, getReviewChangelists, getReviews, getReviews, getRevisionHistory, getRevisionHistory, getServerAddressDetails, getServerFileDiffs, getServerInfo, getServerProcesses, getServerProcesses, getServerVersion, getServerVersionNumber, getShelvedFiles, getShelvedFiles, getSpec, getSSOCallback, getSSOKey, getStatus, getStream, getStream, getStreamingExportRecords, getStreamIntegrationStatus, getStreamlog, getStreams, getSubmittedIntegrations, getSubmittedIntegrations, getTriggerEntries, getTriggersTable, getUsageOptions, getUser, getUserGroup, getUserGroups, getUserGroups, getUserName, getUsers, getUsers, getValidServerIPMACAddress, getWorkingDirectory, guardNull, handleFileReturn, handleFileReturn, init, installExtension, isCaseSensitive, isConnected, isDontWriteTicket, isEnableProgress, isEnableTracking, isNonCheckedSyncs, isQuietMode, isRunningOnWindows, isSecure, isUnicode, journalWait, listExtensions, login, login, login, login, login, login2, login2, login2CheckAuth, login2InitAuth, login2ListMethods, logout, logout, moveFile, moveFile, obliterateFiles, packageExtension, parseVersionString, populatePathArray, registerBrowserCallback, registerCallback, registerProgressCallback, registerSSOCallback, reload, renameClient, renameUser, sampleExtension, searchJobs, setAuthTicket, setCharsetName, setClientName, setClientPath, setCounter, setCounter, setCurrentClient, setCurrentServerInfo, setEnableProgress, setEnableTracking, setFileAttributes, setFileAttributes, setIgnoreFileName, setKey, setNonCheckedSyncs, setOrUnsetServerConfigurationValue, setProperty, setQuietMode, setSecure, setUsageOptions, setUserName, setWorkingDirectory, showServerConfiguration, supportsUnicode, switchClientView, switchStreamView, tagFiles, tagFiles, unload, unsetFileAttribute, unsetFileAttributes, updateBranchSpec, updateClient, updateClient, updateClient, updateExtensionConfig, updateJob, updateLabel, updateLicense, updateProtectionEntries, updateSpec, updateSpecString, updateStream, updateTriggerEntries, updateUser, updateUser, updateUserGroup, updateUserGroup, verifyFiles

Methods inherited from class com.perforce.p4java.server.HelixCommandExecutor
execMapCmdList, handleErrorStr, handleFileErrorStr

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.perforce.p4java.server.IOptionsServer
execInputStringMapCmdList, execInputStringMapCmdList, execInputStringStreamCmd, execInputStringStreamingMapCmd, execMapCmdList, execQuietMapCmdList, execStreamCmd

Methods inherited from interface com.perforce.p4java.server.IServer
execInputStringMapCmd, execInputStringStreamingMapComd, execMapCmd, execQuietMapCmd, execQuietStreamCmd, execStreamingMapCommand, execStreamingMapCommand

Methods inherited from interface com.perforce.p4java.server.IHelixCommandExecutor
execMapCmdList, execMapCmdList, execMapCmdList, execStreamCmd, execStreamCmdForBuffer, handleErrorStr, handleFileErrorStr

- Field Detail
  - IMPL_TYPE
```
public static final IServerImplMetadata.ImplType IMPL_TYPE
```
    The implementation type of this implementation.
  - DEFAULT_PROG_NAME
```
public static final java.lang.String DEFAULT_PROG_NAME
```
    The default string sent to the Perforce server in the protocol command defining the client's program name. This can be set with the IServer interface.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PROG_VERSION
```
public static final java.lang.String DEFAULT_PROG_VERSION
```
    The default string sent to the Perforce server in the protocol command defining the client's program version. This can be set with the IServer interface.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLIENT_API_LEVEL
```
public static final int DEFAULT_CLIENT_API_LEVEL
```
    Default Perforce client API level; 81 represents 2016.2 capabilities. Don't change this unless you know what you're doing. Note that this is a default for most commands; some commands dynamically bump up the level for the command's duration.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SERVER_API_LEVEL
```
public static final int DEFAULT_SERVER_API_LEVEL
```
    Default Perforce server API level; 99999 apparently means "whatever...". Don't change this unless you know what you're doing.
    
    See Also:
    
    Constant Field Values
  - RPC_TAGS_USED
```
public static final boolean RPC_TAGS_USED
```
    Signifies whether or not we use tagged output. Don't change this unless you like weird incomprehensible errors and days of debugging.
    
    See Also:
    
    Constant Field Values
  - RPC_ENABLE_STREAMS
```
public static final boolean RPC_ENABLE_STREAMS
```
    Signifies whether or not the client is capable of handling streams.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_CWD_KEY
```
public static final java.lang.String RPC_ENV_CWD_KEY
```
    The system properties key for the JVM's current directory.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_OS_NAME_KEY
```
public static final java.lang.String RPC_ENV_OS_NAME_KEY
```
    The system properties key for the OS name.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_WINDOWS_PREFIX
```
public static final java.lang.String RPC_ENV_WINDOWS_PREFIX
```
    RPC_ENV_OS_NAME_KEY property value prefix for Windows systems.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_WINDOWS_SPEC
```
public static final java.lang.String RPC_ENV_WINDOWS_SPEC
```
    What we use in the RPC environment packet to signal to the Perforce server that we're a Windows box.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_UNIX_SPEC
```
public static final java.lang.String RPC_ENV_UNIX_SPEC
```
    What we use in the RPC environment packet to signal to the Perforce server that we're a NON-Windows box.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_NOCLIENT_SPEC
```
public static final java.lang.String RPC_ENV_NOCLIENT_SPEC
```
    What we use in the RPC environment packet to signal to the Perforce server that we don't have a client set yet or don't know what it is.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_NOHOST_SPEC
```
public static final java.lang.String RPC_ENV_NOHOST_SPEC
```
    What we use in the RPC environment packet to signal to the Perforce server that we don't have a hostname set yet or don't know what it is.
    
    See Also:
    
    Constant Field Values
  - RPC_ENV_NOUSER_SPEC
```
public static final java.lang.String RPC_ENV_NOUSER_SPEC
```
    What we use in the RPC environment packet to signal to the Perforce server that we don't have a client set yet or don't know what it is.
    
    See Also:
    
    Constant Field Values
  - TRACE_PREFIX
```
public static final java.lang.String TRACE_PREFIX
```
    What we use as a P4JTracer trace prefix for methods here.
    
    See Also:
    
    Constant Field Values
  - RPC_TMP_OUTFILE_STREAM_KEY
```
public static final java.lang.String RPC_TMP_OUTFILE_STREAM_KEY
```
    Used to key temporary output streams in the command environment's state map for things like getFileContents(), etc., using the execStreamCmd method(s).
    
    See Also:
    
    Constant Field Values
  - RPC_BYTE_BUFFER_OUTPUT_KEY
```
public static final java.lang.String RPC_BYTE_BUFFER_OUTPUT_KEY
```
    See Also:
    
    Constant Field Values
  - RPC_TMP_CONVERTER_KEY
```
public static final java.lang.String RPC_TMP_CONVERTER_KEY
```
    Use to key converter to use out of state map
    
    See Also:
    
    Constant Field Values
  - localHostName
```
protected java.lang.String localHostName
```
  - clientApiLevel
```
protected int clientApiLevel
```
  - serverApiLevel
```
protected int serverApiLevel
```
  - applicationName
```
protected java.lang.String applicationName
```
  - connectionStart
```
protected long connectionStart
```
  - serverProtocolMap
```
protected java.util.Map<java.lang.String,java.lang.Object> serverProtocolMap
```
  - serverStats
```
protected ServerStats serverStats
```
  - serverId
```
protected java.lang.String serverId
```
  - secretKeys
```
protected java.util.Map<java.lang.String,java.lang.String> secretKeys
```
  - pBufs
```
protected java.util.Map<java.lang.String,java.lang.String> pBufs
```
  - clientTrust
```
protected ClientTrust clientTrust
```
  - ticketsFilePath
```
protected java.lang.String ticketsFilePath
```
  - trustFilePath
```
protected java.lang.String trustFilePath
```
  - validatedByChain
```
protected boolean validatedByChain
```
  - validatedByFingerprint
```
protected boolean validatedByFingerprint
```
  - validatedByHostname
```
protected boolean validatedByHostname
```
  - authFileLockTry
```
protected int authFileLockTry
```
  - authFileLockDelay
```
protected long authFileLockDelay
```
  - authFileLockWait
```
protected long authFileLockWait
```
  - authCounter
```
protected RpcUserAuthCounter authCounter
```
  - rpcServerAddress
```
protected IServerAddress rpcServerAddress
```
  - cmdMapArgs
```
protected java.util.Map<java.lang.String,java.lang.Object> cmdMapArgs
```
    The RPC command args before the function name (i.e. "tag")
  - relaxCmdNameValidationChecks
```
protected boolean relaxCmdNameValidationChecks
```
    If true, relax the command name validation checks done in the RPC layer. This is dangerous, and any use of this should only be done if you know what you're doing and you're able to deal with the consequences (which won't be spelled out here).
- Constructor Detail
  - RpcServer
```
public RpcServer()
```
- Method Detail
  - isValidatedByChain
```
public boolean isValidatedByChain()
```
    was the server ssl connection validated by chain?
    
    Returns:
    
    true if it's an ssl connection with valid chain
  - isValidatedByFingerprint
```
public boolean isValidatedByFingerprint()
```
    was the server ssl connection validated by fingerprint?
    
    Returns:
    
    true if it's an ssl connection validated by fingerprint
  - isValidatedByHostname
```
public boolean isValidatedByHostname()
```
    was the server ssl connection validated by hostname match?
    
    Returns:
    
    true if it's an ssl connection validated by "cert's CN" == "P4Port's hostname"
  - getApplicationName
```
public java.lang.String getApplicationName()
```
  - setApplicationName
```
public void setApplicationName(java.lang.String applicationName)
```
  - getAuthCounter
```
public RpcUserAuthCounter getAuthCounter()
```
    Get the RPC user authentication counter.
    
    Returns:
    
    RPC user authentication counter
  - getClientApiLevel
```
public int getClientApiLevel()
```
  - setClientApiLevel
```
public void setClientApiLevel(int clientApiLevel)
```
  - getPerfMonitor
```
public PerformanceMonitor getPerfMonitor()
```
  - setPerfMonitor
```
public void setPerfMonitor(PerformanceMonitor perfMonitor)
```
  - getRpcServerAddress
```
public IServerAddress getRpcServerAddress()
```
    Get the server's address for the RPC connection.
    
    Returns:
    
    possibly-null RPC server address
  - setRpcServerAddress
```
public void setRpcServerAddress(IServerAddress rpcServerAddress)
```
    Set the server's address for the RPC connection.
    
    Parameters:
    
    rpcServerAddress - RPC server address
  - getServerAddress
```
public java.lang.String getServerAddress()
```
    Get the server's address field used for storing authentication tickets.
    
    Returns:
    
    - possibly null server address
  - getServerHostPort
```
public java.lang.String getServerHostPort()
```
    Get the server's host and port used for the RPC connection.
    
    Returns:
    
    - possibly null server host and port
  - getClientCharset
```
public java.nio.charset.Charset getClientCharset()
```
  - isServerUnicode
```
public boolean isServerUnicode()
```
  - getServerId
```
public java.lang.String getServerId()
```
    Get the server's id field used for storing authentication tickets. This id should only be used as a server address portion for entries in a p4 tickets file.
    
    Returns:
    
    - possibly null server id
  - setServerId
```
public void setServerId(java.lang.String serverId)
```
    Set the server's id field used for storing authentication tickets. The id specified here will be used when saving ticket values to a p4 tickets file. This field should only be set to the server id returned as part of a server message.
    
    Parameters:
    
    serverId - serverId
  - getTicketsFilePath
```
public java.lang.String getTicketsFilePath()
```
    Description copied from interface: IOptionsServer
    
    Return the Perforce authentication tickets file path.
    
    Returns:
    
    possibly-null Perforce auth tickets file path
  - setTicketsFilePath
```
public void setTicketsFilePath(java.lang.String ticketsFilePath)
```
    Description copied from interface: IOptionsServer
    
    Set the Perforce authentication tickets file path.
    
    Parameters:
    
    ticketsFilePath - non-null Perforce auth tickets file path
  - getTrustFilePath
```
public java.lang.String getTrustFilePath()
```
    Description copied from interface: IOptionsServer
    
    Return the Perforce trust file path.
    
    Returns:
    
    possibly-null Perforce trust file path
  - setTrustFilePath
```
public void setTrustFilePath(java.lang.String trustFilePath)
```
    Description copied from interface: IOptionsServer
    
    Set the Perforce trust file path.
    
    Parameters:
    
    trustFilePath - non-null Perforce trust file path
  - isRelaxCmdNameValidationChecks
```
protected boolean isRelaxCmdNameValidationChecks()
```
  - setRelaxCmdNameValidationChecks
```
protected void setRelaxCmdNameValidationChecks(boolean relaxCmdNameValidationChecks)
```
  - isAuthFail
```
@Deprecated
public boolean isAuthFail(java.lang.String errStr)
```
    Deprecated. use ResultMapParser.isAuthFail(String)
    
    Parameters:
    
    errStr - error string
    
    Returns:
    
    true if error
  - getInfoStr
```
@Deprecated
public java.lang.String getInfoStr(java.util.Map<java.lang.String,java.lang.Object> map)
```
    Deprecated. use ResultMapParser.getInfoStr(Map)
    
    Description copied from interface: IHelixCommandExecutor
    Gets the info message from the passed-in Perforce command results map. If no info message found in the results map it returns null.
    Note that the severity code is MessageSeverityCode.E_INFO. Therefore, only message with severity code = MessageSeverityCode.E_INFO will be returned.
    RPC impl errors come across the wire as a map in the form usually like this:
```
 fmt0=Access for user '%user%' has not been enabled by 'p4 protect'.,
 func=client-Message, user=nouser, code0=822483067
 
```
    Note that the code0 entry will be used to get the severity level; the fmt0 entry contains the message.
    Parameters:
    
    map - Perforce command results map
    
    Returns:
    
    possibly-null info string
  - isInfoMessage
```
@Deprecated
public boolean isInfoMessage(java.util.Map<java.lang.String,java.lang.Object> map)
```
    Deprecated. use ResultMapParser.isInfoMessage(Map)
    
    Description copied from interface: IHelixCommandExecutor
    
    Checks if is info message.
    
    Parameters:
    
    map - the map
    
    Returns:
    
    true, if is info message
  - getErrorStr
```
@Deprecated
public java.lang.String getErrorStr(java.util.Map<java.lang.String,java.lang.Object> map)
```
    Deprecated. use ResultMapParser.getErrorStr(Map)
    
    Description copied from interface: IHelixCommandExecutor
    Gets the error/fatal message from the passed-in Perforce command results map. If no error/fatal message found in the results map it returns null.
    Note that the minimum severity code is MessageSeverityCode.E_FAILED. Therefore, only message with severity code >= MessageSeverityCode.E_FAILED will be returned.
    RPC impl errors come across the wire as a map in the form usually like this:
```
 fmt0=Access for user '%user%' has not been enabled by 'p4 protect'.,
 func=client-Message, user=nouser, code0=822483067
 
```
    Note that the code0 entry will be used to get the severity level; the fmt0 entry contains the message.
    Parameters:
    
    map - Perforce command results map
    
    Returns:
    
    possibly-null error/fatal string
  - setAuthTicket
```
@Deprecated
public void setAuthTicket(java.lang.String userName,
                                      java.lang.String authTicket)
```
    Deprecated. use setAuthTicket(String, String, String)
    
    Description copied from interface: IOptionsServer
    
    Set the server's Perforce authentication ticket for the specified user to the passed-in string.
    
    Parameters:
    
    userName - non-null Perforce user name
    
    authTicket - possibly-null Perforce authentication ticket
  - setAuthTicket
```
public void setAuthTicket(java.lang.String userName,
                          java.lang.String serverId,
                          java.lang.String authTicket)
```
    Description copied from interface: IOptionsServer
    
    Set the server's Perforce authentication ticket for the specified user to the passed-in string.
    
    Parameters:
    
    userName - non-null Perforce user name
    
    serverId - possibly-null Perforce server's auth.id/IP:port
    
    authTicket - possibly-null Perforce authentication ticket
  - getTrust
```
public java.lang.String getTrust()
                          throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    Return the fingerprint for the Perforce SSL connection.
    Note that this fingerprint is generated from the connection, it may not be the same as the one (if any) stored in the trust file.
    
    Returns:
    
    possibly-null fingerprint for the Perforce SSL connection.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - addTrust
```
public java.lang.String addTrust(TrustOptions opts)
                          throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    Approve and add the fingerprint for the Perforce SSL connection. The fingerprint or replacement will be stored in the trust file. If the attribute TrustOptions.isReplacement() is true, then the replacement fingerprint will be stored. Otherwise, the normal fingerprint is stored.
    Note that an exception would be thrown if there is an identity change detected. If you want to trust the new key use the 'force' option.
    
    Parameters:
    
    opts - TrustOptions object describing optional parameters; if null, no options are set.
    
    Returns:
    
    non-null result message string from the trust operation; this may include the fingerprint for the Perforce server public key.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - addTrust
```
public java.lang.String addTrust(java.lang.String fingerprintValue)
                          throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    Approve and add the specified fingerprint for the Perforce SSL connection. The fingerprint will be stored in the trust file.
    
    Parameters:
    
    fingerprintValue - non-null fingerprint value to be added.
    
    Returns:
    
    non-null result message string from the trust operation; this may include the fingerprint for the Perforce server public key.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - addTrust
```
public java.lang.String addTrust(java.lang.String fingerprintValue,
                                 TrustOptions options)
                          throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    Approve and add the specified fingerprint or replacement for the Perforce SSL connection. The fingerprint or replacement will be stored in the trust file. If the attribute TrustOptions.isReplacement() is true, then the replacement fingerprint will be stored. Otherwise, the normal fingerprint is stored.
    
    Parameters:
    
    fingerprintValue - non-null fingerprint value to be added.
    
    options - TrustOptions object describing optional parameters; if null, no options are set.
    
    Returns:
    
    non-null result message string from the trust operation; this may include the fingerprint for the Perforce server public key.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - removeTrust
```
public java.lang.String removeTrust()
                             throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    Remove the fingerprint for the Perforce SSL connection. The fingerprint will removed from the trust file.
    
    Returns:
    
    non-null result message string from the trust operation; this may include the fingerprint for the Perforce server public key.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - removeTrust
```
public java.lang.String removeTrust(TrustOptions opts)
                             throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    Remove the fingerprint or replacement for the Perforce SSL connection. The fingerprint or replacement will removed from the trust file. If the attribute TrustOptions.isReplacement() is true, then the replacement fingerprint will be removed. Otherwise the normal fingerprint is removed.
    
    Parameters:
    
    opts - TrustOptions object describing optional parameters; if null, no options are set.
    
    Returns:
    
    non-null result message string from the trust operation; this may include the fingerprint for the Perforce server public key.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - getTrusts
```
public java.util.List<Fingerprint> getTrusts()
                                      throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    List all fingerprints in the trust file.
    
    Returns:
    
    non-null list of known fingerprints in the trust file.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - getTrusts
```
public java.util.List<Fingerprint> getTrusts(TrustOptions opts)
                                      throws P4JavaException
```
    Description copied from interface: IOptionsServer
    
    List all fingerprints or replacements in the trust file. If the attribute TrustOptions.isReplacement() is true, then replacement fingerprints will be returned. Otherwise, normal fingerprints are returned.
    
    Parameters:
    
    opts - TrustOptions object describing optional parameters; if null, no options are set.
    
    Returns:
    
    non-null list of fingerprints in the trust file.
    
    Throws:
    
    P4JavaException - if an error occurs processing this method and its parameters.
  - connect
```
public void connect()
             throws ConnectionException,
                    AccessException,
                    RequestException,
                    ConfigException
```
    Try to establish an actual RPC connection to the target Perforce server. Most of the actual setup work is done in the RpcConnection and RpcPacketDispatcher constructors, but associated gubbins such as auto login, etc., are done in the superclass.
    
    Specified by:
    
    connect in interface IServer
    
    Overrides:
    
    connect in class Server
    
    Throws:
    
    ConnectionException - if the Perforce server is unreachable or is not connected.
    
    AccessException - if the Perforce server denies access to the caller
    
    RequestException - if the Perforce server encounters an error during its processing of the request
    
    ConfigException - if local I/O exception occurs
  - disconnect
```
public void disconnect()
                throws ConnectionException,
                       AccessException
```
    Try to cleanly disconnect from the Perforce server at the other end of the current connection (with the emphasis on "cleanly"). This should theoretically include sending a release2 message, but we don't always get the chance to do that.
    
    Specified by:
    
    disconnect in interface IServer
    
    Overrides:
    
    disconnect in class Server
    
    Throws:
    
    ConnectionException - on error
    
    AccessException - on error
  - getAuthTicket
```
@Deprecated
public java.lang.String getAuthTicket(java.lang.String userName)
```
    Deprecated. use getAuthTicket(String, String)
    
    Description copied from interface: IServer
    
    Return the Perforce authentication ticket for specified user.
    
    Parameters:
    
    userName - non-null Perforce user name
    
    Returns:
    
    possibly-null Perforce authentication ticket
  - getAuthTicket
```
public java.lang.String getAuthTicket(java.lang.String userName,
                                      java.lang.String serverId)
```
    Description copied from interface: IServer
    
    Return the Perforce authentication ticket for specified user.
    
    Parameters:
    
    userName - non-null Perforce user name
    
    serverId - non-null Perforce server's auth.id/IP:port
    
    Returns:
    
    possibly-null Perforce authentication ticket
  - isLoginNotRequired
```
public boolean isLoginNotRequired(java.lang.String msgStr)
```
  - supportsSmartMove
```
public boolean supportsSmartMove()
                          throws ConnectionException,
                                 RequestException,
                                 AccessException
```
    Description copied from interface: IServer
    
    Return true IFF the underlying Perforce server supports the new 2009.1 and later "smart move" command. Note that this returns whether the server can support moves only at the time the server is first created; it's entirely possible for the underlying server to change versions, etc., under the user in the meanitme or over time. In any case, if you do try to run a move command on such a server, the results will be safe, if not entirely what you expected. As of 2010.2 it also possible for the server to be configured to disable the move command, in which case this function will return false.
    
    Returns:
    
    true iff the server supports the smart move command.
    
    Throws:
    
    ConnectionException - if the Perforce server is unreachable or is not connected.
    
    RequestException - if the Perforce server encounters an error during its processing of the request
    
    AccessException - if the Perforce server denies access to the caller
  - init
```
public ServerStatus init(java.lang.String host,
                         int port,
                         java.util.Properties properties,
                         UsageOptions opts,
                         boolean secure)
                  throws ConfigException,
                         ConnectionException
```
    Description copied from interface: IServerControl
    
    Convenience method for init(host, port, props, opts, secure, null). See init's main Javadoc for full documentation.
    
    Specified by:
    
    init in interface IServerControl
    
    Overrides:
    
    init in class Server
    
    Parameters:
    
    host - the Perforce server hostname or IP address as passed in to the factory method
    
    port - the Perforce server port number as passed in to the factory method
    
    properties - the properties passed in to the factory method
    
    opts - the UsageOptions object to be associated with the server object; if null, the server should construct a new default UsageOptions object.
    
    secure - secure option
    
    Returns:
    
    the resulting status; should be ACTIVE unless otherwise specified
    
    Throws:
    
    ConfigException - if there's something wrong with the specified configuration or associated config files, etc.
    
    ConnectionException - if the server is unreachable on initialization, and that unreachability is serious and unrecoverable (there are implementations that don't really do connections per se, so they may not consider this an error or even try connecting during initialisation).
  - init
```
public ServerStatus init(java.lang.String host,
                         int port,
                         java.util.Properties props,
                         UsageOptions opts)
                  throws ConfigException,
                         ConnectionException
```
    Description copied from interface: IServerControl
    
    Convenience method for init(host, port, props, opts, secure). See init's main Javadoc for full documentation.
    
    Specified by:
    
    init in interface IServerControl
    
    Overrides:
    
    init in class Server
    
    Parameters:
    
    host - the Perforce server hostname or IP address as passed in to the factory method
    
    port - the Perforce server port number as passed in to the factory method
    
    props - the properties passed in to the factory method
    
    opts - the UsageOptions object to be associated with the server object; if null, the server should construct a new default UsageOptions object.
    
    Returns:
    
    the resulting status; should be ACTIVE unless otherwise specified
    
    Throws:
    
    ConfigException - if there's something wrong with the specified configuration or associated config files, etc.
    
    ConnectionException - if the server is unreachable on initialization, and that unreachability is serious and unrecoverable (there are implementations that don't really do connections per se, so they may not consider this an error or even try connecting during initialisation).
  - init
```
public ServerStatus init(java.lang.String host,
                         int port,
                         java.util.Properties props)
                  throws ConfigException,
                         ConnectionException
```
    The default init sets up things like host names, etc., and fails if we can't establish some pretty basic things at connect time. Does not attempt to actually connect to the target Perforce server -- this is left for the connect() call, below.
    
    Specified by:
    
    init in interface IServerControl
    
    Overrides:
    
    init in class Server
    
    Parameters:
    
    host - the Perforce server hostname or IP address as passed in to the factory method
    
    port - the Perforce server port number as passed in to the factory method
    
    props - the UsageOptions object to be associated with the server object; if null, the server should construct a new default UsageOptions object.
    
    Returns:
    
    the resulting status; should be ACTIVE unless otherwise specified
    
    Throws:
    
    ConfigException - if there's something wrong with the specified configuration or associated config files, etc.
    
    ConnectionException - if the server is unreachable on initialization, and that unreachability is serious and unrecoverable (there are implementations that don't really do connections per se, so they may not consider this an error or even try connecting during initialisation).
  - trustConnectionCheck
```
public void trustConnectionCheck(RpcConnection rpcConnection)
                          throws ConnectionException
```
    Check Server Trust
    Certificate Validation depends on RPC_SSL_CLIENT_CERT_VALIDATE_NICK.
    Self-signed certs use only a fingerprint comparison after checking the cert's dates.
    
    Parameters:
    
    rpcConnection - rpcConnection
    
    Throws:
    
    ConnectionException - on error
  - checkFingerprint
```
protected void checkFingerprint(RpcConnection rpcConnection)
                         throws ConnectionException
```
    Check the fingerprint of the Perforce server SSL connection
    
    Parameters:
    
    rpcConnection - rpcConnection
    
    Throws:
    
    ConnectionException - on error
  - composeAuthTicketEntryKey
```
protected java.lang.String composeAuthTicketEntryKey(java.lang.String userName,
                                                     java.lang.String serverAddress)
```
    Compose the key for an auth ticket entry
    
    Parameters:
    
    userName - userName
    
    serverAddress - serverAddress
    
    Returns:
    
    key
  - getClientNameForEnv
```
protected java.lang.String getClientNameForEnv()
```
  - getHostForEnv
```
protected java.lang.String getHostForEnv()
```
  - getLanguageForEnv
```
protected java.lang.String getLanguageForEnv()
```
  - getOsTypeForEnv
```
protected java.lang.String getOsTypeForEnv()
```
  - getRpcPacketFieldRule
```
protected RpcPacketFieldRule getRpcPacketFieldRule(java.util.Map<java.lang.String,java.lang.Object> inMap,
                                                   CmdSpec cmdSpec)
```
    Get the RPC packet field rule for skipping the charset conversion of a range of RPC packet fields; leave the values as bytes.
    Note: currently only supporting the "export" command.
    
    Parameters:
    
    inMap - inMap
    
    cmdSpec - cmdSpec
    
    Returns:
    
    RpcPacketFieldRule
  - getSecretKey
```
public java.lang.String getSecretKey()
```
  - setSecretKey
```
public void setSecretKey(java.lang.String secretKey)
```
  - getSecretKey
```
public java.lang.String getSecretKey(java.lang.String userName)
```
  - getPBuf
```
public java.lang.String getPBuf(java.lang.String userName)
```
  - getUserForEnv
```
protected java.lang.String getUserForEnv()
```
  - loadFingerprint
```
public Fingerprint loadFingerprint(java.lang.String serverKey,
                                   java.lang.String fingerprintUser)
```
    Get the p4trust entry value for the server IP and port based upon a search of either the file found at PropertyDefs.TRUST_PATH_KEY_SHORT_FORM, PropertyDefs.TRUST_PATH_KEY, the P4TRUST environment variable or the standard p4trust file location for the current OS. Will return null if not found or if an error occurred attempt to lookup the value.
    
    Parameters:
    
    serverKey - serverKey
    
    fingerprintUser - fingerprintUser
    
    Returns:
    
    - fingerprint or null if not found.
  - loadFingerprints
```
public Fingerprint[] loadFingerprints()
```
    Get the p4trust entries from the file found at PropertyDefs.TRUST_PATH_KEY_SHORT_FORM, PropertyDefs.TRUST_PATH_KEY, the P4TRUST environment variable or the standard p4trust file location for the current OS. Will return null if nothing found or if an error occurred attempt to lookup the entries.
    
    Returns:
    
    - list of fingerprints or null if nothing found.
  - loadTicket
```
@Nullable
public java.lang.String loadTicket(java.lang.String serverId)
```
    Get the p4tickets entry value for the current user returned from Server.getUserName() and server address based upon a search of either the file found at PropertyDefs.TICKET_PATH_KEY_SHORT_FORM, PropertyDefs.TICKET_PATH_KEY, the P4TICKETS environment variable or the standard p4tickets file location for the current OS. Will return null if not found or if an error occurred attempt to lookup the value.
    
    Parameters:
    
    serverId - serverId
    
    Returns:
    
    - ticket value to get used for Server.setAuthTicket(String) or null if not found.
  - loadTicket
```
public java.lang.String loadTicket(java.lang.String serverId,
                                   java.lang.String name)
```
    Get the p4tickets entry value for the specified user and server address based upon a search of either the file found at PropertyDefs.TICKET_PATH_KEY_SHORT_FORM, PropertyDefs.TICKET_PATH_KEY, the P4TICKETS environment variable or the standard p4tickets file location for the current OS. Will return null if not found or if an error occurred attempt to lookup the value.
    
    Parameters:
    
    serverId - serverId
    
    name - name
    
    Returns:
    
    - ticket value to get used for Server.setAuthTicket(String) or null if not found.
  - processCmdCallbacks
```
protected void processCmdCallbacks(int cmdCallBackKey,
                                   long timeTaken,
                                   java.util.List<java.util.Map<java.lang.String,java.lang.Object>> resultMaps)
```
  - getErrorOrInfoStr
```
@Deprecated
public java.lang.String getErrorOrInfoStr(java.util.Map<java.lang.String,java.lang.Object> map)
```
    Deprecated. use ResultMapParser.getErrorOrInfoStr(Map)
    
    Description copied from interface: IHelixCommandExecutor
    Gets the info/warning/error/fatal message from the passed-in Perforce command results map. If no info/warning/error/fatal message found in the results map it returns null.
    Note that the minimum severity code is MessageSeverityCode.E_INFO. Therefore, only message with severity code >= MessageSeverityCode.E_INFO will be returned.
    RPC impl errors come across the wire as a map in the form usually like this:
```
 fmt0=Access for user '%user%' has not been enabled by 'p4 protect'.,
 func=client-Message, user=nouser, code0=822483067
 
```
    Note that the code0 entry will be used to get the severity level; the fmt0 entry contains the message.
    Parameters:
    
    map - Perforce command results map
    
    Returns:
    
    possibly-null info/warning/error/fatal string
  - getSeverityCode
```
public int getSeverityCode(java.util.Map<java.lang.String,java.lang.Object> map)
```
  - getGenericCode
```
public int getGenericCode(java.util.Map<java.lang.String,java.lang.Object> map)
```
  - getAuthId
```
public java.lang.String getAuthId()
```
    Return the Perforce Server's authId.
    This may be: addr:port or clusterId or authId If the connection hasn't been made yet, this could be null.
    
    Returns:
    
    possibly-null Perforce authentication id
    
    Since:
    
    2016.1
  - saveCurrentTicket
```
@Deprecated
public void saveCurrentTicket()
                                   throws P4JavaException
```
    Deprecated. use saveTicket(String, String, String)
    
    Save current ticket returned from Server.getAuthTicket().
    
    Throws:
    
    P4JavaException - on error
  - saveTicket
```
@Deprecated
public void saveTicket(java.lang.String ticketValue)
                            throws ConfigException
```
    Deprecated. use saveTicket(String, String, String)
    
    Save specified auth ticket value as associate with this server's address and configured user returned from Server.getUserName(). This will attempt to write an entry to the p4tickets file either specified as the P4TICKETS environment variable or at the OS specific default location. If the ticket value is null then the current entry in the will be cleared.
    
    Parameters:
    
    ticketValue - ticketValue
    
    Throws:
    
    ConfigException - on error
  - saveFingerprint
```
public void saveFingerprint(java.lang.String serverIpPort,
                            java.lang.String fingerprintUser,
                            java.lang.String fingerprintValue)
                     throws ConfigException
```
    Save specified fingerprint value as associate with this server's address. This will attempt to write an entry to the p4trust file either specified as the P4TRUST environment variable or at the OS specific default location. If the fingerprint value is null then the current entry will be cleared.
    
    Parameters:
    
    serverIpPort - serverIpPort
    
    fingerprintUser - fingerprintUser
    
    fingerprintValue - fingerprintValue
    
    Throws:
    
    ConfigException - on error
  - saveTicket
```
public void saveTicket(java.lang.String userName,
                       java.lang.String serverId,
                       java.lang.String ticketValue)
                throws ConfigException
```
    Save specified auth ticket value as associate with this server's address and user name from the userName parameter. This will attempt to write an entry to the p4tickets file either specified as the P4TICKETS environment variable or at the OS specific default location. If the ticket value is null then the current entry will be cleared.
    
    Parameters:
    
    userName - userName
    
    serverId - serverId
    
    ticketValue - ticketValue
    
    Throws:
    
    ConfigException - on error
  - setSecretKey
```
public void setSecretKey(java.lang.String userName,
                         java.lang.String secretKey)
```
  - setPbuf
```
public void setPbuf(java.lang.String userName,
                    java.lang.String pBuf)
```
  - useTags
```
protected boolean useTags(java.lang.String cmdName,
                          java.lang.String[] cmdArgs,
                          java.util.Map<java.lang.String,java.lang.Object> inMap,
                          boolean isStreamCmd)
```
    Allow for per-command use of tags or not. Currently has limited use (only a few commands are anomalous as far as we can tell), but may find more uses generally with experience.
    This is normally used on a per-command (OneShot RPC server) basis. In order to use this on a per-session (NTS RPC server) implementation you must resend the RPC protocol, if the 'useTags' state has changed, prior to sending the command.
    
    Parameters:
    
    cmdName - cmdName
    
    cmdArgs - cmdArgs
    
    inMap - inMap
    
    isStreamCmd - isStreamCmd
    
    Returns:
    
    RPC_TAGS_USED | false
  - writeInPlace
```
protected boolean writeInPlace(java.lang.String cmdName)
```
    Return true if we should be performing server -> client file write I/O operations in place for this command.
    See PropertyDefs.WRITE_IN_PLACE_KEY javadoc for the semantics of this.
    
    Parameters:
    
    cmdName - non-null command command name string
    
    Returns:
    
    true iff we should do a sync in place

Class RpcServer

Field Summary

Fields inherited from class com.perforce.p4java.impl.mapbased.server.Server

Fields inherited from interface com.perforce.p4java.server.IServer

Constructor Summary

Method Summary

Methods inherited from class com.perforce.p4java.impl.mapbased.server.Server

Methods inherited from class com.perforce.p4java.server.HelixCommandExecutor

Methods inherited from class java.lang.Object

Methods inherited from interface com.perforce.p4java.server.IOptionsServer

Methods inherited from interface com.perforce.p4java.server.IServer

Methods inherited from interface com.perforce.p4java.server.IHelixCommandExecutor

Field Detail

IMPL_TYPE

DEFAULT_PROG_NAME

DEFAULT_PROG_VERSION

DEFAULT_CLIENT_API_LEVEL

DEFAULT_SERVER_API_LEVEL

RPC_TAGS_USED

RPC_ENABLE_STREAMS

RPC_ENV_CWD_KEY

RPC_ENV_OS_NAME_KEY

RPC_ENV_WINDOWS_PREFIX

RPC_ENV_WINDOWS_SPEC

RPC_ENV_UNIX_SPEC

RPC_ENV_NOCLIENT_SPEC

RPC_ENV_NOHOST_SPEC

RPC_ENV_NOUSER_SPEC

TRACE_PREFIX

RPC_TMP_OUTFILE_STREAM_KEY

RPC_BYTE_BUFFER_OUTPUT_KEY

RPC_TMP_CONVERTER_KEY

localHostName

clientApiLevel

serverApiLevel

applicationName

connectionStart

serverProtocolMap

serverStats

serverId

secretKeys

pBufs

clientTrust

ticketsFilePath

trustFilePath

validatedByChain

validatedByFingerprint

validatedByHostname

authFileLockTry

authFileLockDelay

authFileLockWait

authCounter

rpcServerAddress

cmdMapArgs

relaxCmdNameValidationChecks

Constructor Detail

RpcServer

Method Detail

isValidatedByChain

isValidatedByFingerprint

isValidatedByHostname

getApplicationName

setApplicationName

getAuthCounter

getClientApiLevel

setClientApiLevel

getPerfMonitor

setPerfMonitor

getRpcServerAddress

setRpcServerAddress

getServerAddress

getServerHostPort

getClientCharset

isServerUnicode

getServerId

setServerId

getTicketsFilePath

setTicketsFilePath

getTrustFilePath

setTrustFilePath