Package com.perforce.p4java.impl.mapbased.rpc

Class CommandEnv

java.lang.Object
com.perforce.p4java.impl.mapbased.rpc.CommandEnv
public class CommandEnv extends Object
Used to package up the Perforce function environment for a single Perforce command across multiple RPC function calls.

In particular, we need to keep things like file handles, arbitrary RPC function arguments, etc., around for use during complex long-running commands that span many dispatch calls in loop or duplex mode, etc., in response to single user commands like 'sync'.

Note that this is in distinction to a) the command's external environment (in the ExternalEnv class), and b) the command's individual function environments,

  • Field Details

    • MAX_HANDLERS

      public static final int MAX_HANDLERS
      Max number of live handlers per command cycle. Value copied straight from the C++ API.
      See Also:

    • LINE_SEPARATOR

      public static final String LINE_SEPARATOR
      Sequence used by operating system to separate lines in text files. Default to "\n" if it is not available.

  • Constructor Details

  • Method Details

    • addHandler

      public boolean addHandler(CommandEnv.RpcHandler handler)

    • handleResult

      public void handleResult(Map<String,Object> resultMap)
      Handle a result by either adding it to the resultsMapVec for later processing or passing it up to the streaming results callback handler.
      Parameters:
      resultMap - resultMap

    • handlePartialResult

      public void handlePartialResult(Map<String,Object> resultMap)
      Handle a partial result by either adding it to the resultsMapVec for later processing or passing it up to the streaming results callback handler.
      Parameters:
      resultMap - resultMap

    • resetPartialResult

      public void resetPartialResult()

    • getHandler

      public CommandEnv.RpcHandler getHandler(String handlerName)

    • getCmdSpec

      public RpcCmdSpec getCmdSpec()

    • setCmdSpec

      public void setCmdSpec(RpcCmdSpec cmdSpec)

    • getResultMaps

      public List<Map<String,Object>> getResultMaps()

    • setResultMaps

      public void setResultMaps(List<Map<String,Object>> resultMaps)

    • clearLastResultMap

      public void clearLastResultMap()

    • getStateMap

      public Map<String,Object> getStateMap()

    • setStateMap

      public void setStateMap(Map<String,Object> stateMap)

    • getProtocolSpecs

      public ProtocolCommand getProtocolSpecs()

    • getServerProtocolLevel

      public int getServerProtocolLevel()

    • setProtocolSpecs

      public void setProtocolSpecs(ProtocolCommand protocolSpecs)

    • getRpcConnection

      public RpcConnection getRpcConnection()

    • setRpcConnection

      public void setRpcConnection(RpcConnection rpcConnection)

    • getHandlers

      public CommandEnv.RpcHandler[] getHandlers()

    • setHandlers

      public void setHandlers(CommandEnv.RpcHandler[] handlers)

    • newHandler

      public void newHandler()

    • getServerProtocolSpecsMap

      public Map<String,Object> getServerProtocolSpecsMap()

    • setServerProtocolSpecsMap

      public void setServerProtocolSpecsMap(Map<String,Object> serverProtocolSpecsMap)

    • getProgressCallback

      public IProgressCallback getProgressCallback()

    • setProgressCallback

      public void setProgressCallback(IProgressCallback progressCallback)

    • getCmdCallBackKey

      public int getCmdCallBackKey()

    • setCmdCallBackKey

      public void setCmdCallBackKey(int cmdCallBackKey)

    • isUserCanceled

      public boolean isUserCanceled()

    • setUserCanceled

      public void setUserCanceled(boolean userCanceled)

    • isSyncInPlace

      public boolean isSyncInPlace()

    • setSyncInPlace

      public void setSyncInPlace(boolean syncInPlace)

    • getStreamingCallback

      public IStreamingCallback getStreamingCallback()

    • setStreamingCallback

      public void setStreamingCallback(IStreamingCallback streamingCallback)

    • getStreamingCallbackKey

      public int getStreamingCallbackKey()

    • setStreamingCallbackKey

      public void setStreamingCallbackKey(int streamingCallbackKey)

    • isNonCheckedSyncs

      public boolean isNonCheckedSyncs()

    • setNonCheckedSyncs

      public void setNonCheckedSyncs(boolean nonCheckedSyncs)

    • isDontWriteTicket

      public boolean isDontWriteTicket()

    • setDontWriteTicket

      public void setDontWriteTicket(boolean dontWriteTicket)

    • isStreamCmd

      public boolean isStreamCmd()

    • setStreamCmd

      public void setStreamCmd(boolean streamCmd)

    • getFieldRule

      public RpcPacketFieldRule getFieldRule()

    • setFieldRule

      public void setFieldRule(RpcPacketFieldRule fieldRule)

    • getFilterCallback

      public IFilterCallback getFilterCallback()

    • setFilterCallback

      public void setFilterCallback(IFilterCallback filterCallback)

    • getParallelCallback

      public IParallelCallback getParallelCallback()

    • setParallelCallback

      public void setParallelCallback(IParallelCallback parallelCallback)

    • getClientProgressCallback

      public IProgress getClientProgressCallback()

    • setClientProgressCallback

      public void setClientProgressCallback(IProgress clientProgressCallback)

    • getServer

      public RpcServer getServer()

    • getSyncTime

      public long getSyncTime()

    • setSyncTime

      public void setSyncTime(long syncTime)

    • isNullSync

      public boolean isNullSync()

    • setNullSync

      public void setNullSync(boolean nullSync)

    • isBufferOutput

      public boolean isBufferOutput()

    • setBufferOutput

      public void setBufferOutput(boolean bufferOutput)