P4ClientExecutor (Maven SCM Perforce Provider 2011.1.297684 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.maven.scm.provider.p4.command
Class P4ClientExecutor

java.lang.Object
  com.perforce.maven.scm.provider.p4.command.P4Executor
      com.perforce.maven.scm.provider.p4.command.P4ServerExecutor
          com.perforce.maven.scm.provider.p4.command.P4ClientExecutor

public class P4ClientExecutor
extends P4ServerExecutor
extends P4ServerExecutor

This class is for Perforce client specific command. It initializes an instance of the Perforce server and an instance of the Perforce client.

Field Summary

Fields inherited from class com.perforce.maven.scm.provider.p4.command.P4Executor
`client, fileSet, logger, P4_CHANGELIST_DESCRIPTION_PROPERTY, P4_CHANGELIST_PROPERTY, P4_CHARSET_PROPERTY, P4_CLIENT_PROPERTY, P4_FROM_CHANGELIST_PROPERTY, P4_JOBS_PROPERTY, P4_LOCK_TAG_PROPERTY, P4_PASSWD_PROPERTY, P4_PORT_PROPERTY, P4_TO_CHANGELIST_PROPERTY, P4_USER_PROPERTY, p4Charset, p4Client, p4ClientCreated, p4LoginOptions, p4Passwd, p4Port, p4ServerOptions, p4ServerProperties, p4User, repository, server`

Fields inherited from class com.perforce.maven.scm.provider.p4.command.P4Executor

client, fileSet, logger, P4_CHANGELIST_DESCRIPTION_PROPERTY, P4_CHANGELIST_PROPERTY, P4_CHARSET_PROPERTY, P4_CLIENT_PROPERTY, P4_FROM_CHANGELIST_PROPERTY, P4_JOBS_PROPERTY, P4_LOCK_TAG_PROPERTY, P4_PASSWD_PROPERTY, P4_PORT_PROPERTY, P4_TO_CHANGELIST_PROPERTY, P4_USER_PROPERTY, p4Charset, p4Client, p4ClientCreated, p4LoginOptions, p4Passwd, p4Port, p4ServerOptions, p4ServerProperties, p4User, repository, server

Constructor Summary
`P4ClientExecutor(P4ScmProviderRepository repository, org.apache.maven.scm.ScmFileSet fileSet, org.apache.maven.scm.log.ScmLogger logger)` Instantiates a new p4 server executor.

Method Summary
`protected void`	`cleanClient()` Cleanup the Perforce client instance.
`protected void`	`cleanP4()` Cleanup Perforce server and client instances; logout, disconnect, etc.
`protected void`	`initClient()` Initialize an instance of the Perforce client from the server with a specified client name.
`protected void`	`initP4()` Initialize Perforce server and client instances.

Methods inherited from class com.perforce.maven.scm.provider.p4.command.P4ServerExecutor
`cleanServer, initServer`

Methods inherited from class com.perforce.maven.scm.provider.p4.command.P4Executor
createClientViewMapping, encodeWildcards, generateClientName, getCanonicalRepoPath, getClient, getFileSet, getLogger, getP4Charset, getP4Client, getP4LoginOptions, getP4Passwd, getP4Port, getP4ServerOptions, getP4ServerProperties, getP4User, getRepoLocation, getRepoPath, getRepository, getServer, isClientNameGenerated, isEmpty, isP4ClientCreated, parseChangelist, setClient, setFileSet, setLogger, setP4Charset, setP4Client, setP4ClientCreated, setP4LoginOptions, setP4Passwd, setP4Port, setP4ServerOptions, setP4ServerProperties, setP4User, setRepository, setServer

Methods inherited from class com.perforce.maven.scm.provider.p4.command.P4Executor

createClientViewMapping, encodeWildcards, generateClientName, getCanonicalRepoPath, getClient, getFileSet, getLogger, getP4Charset, getP4Client, getP4LoginOptions, getP4Passwd, getP4Port, getP4ServerOptions, getP4ServerProperties, getP4User, getRepoLocation, getRepoPath, getRepository, getServer, isClientNameGenerated, isEmpty, isP4ClientCreated, parseChangelist, setClient, setFileSet, setLogger, setP4Charset, setP4Client, setP4ClientCreated, setP4LoginOptions, setP4Passwd, setP4Port, setP4ServerOptions, setP4ServerProperties, setP4User, setRepository, setServer

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

Constructor Detail

P4ClientExecutor

public P4ClientExecutor(P4ScmProviderRepository repository,
                        org.apache.maven.scm.ScmFileSet fileSet,
                        org.apache.maven.scm.log.ScmLogger logger)
                 throws org.apache.maven.scm.ScmException

Instantiates a new p4 server executor.

Parameters:: repository - the repository; fileSet - the file set; logger - the logger
Throws:: org.apache.maven.scm.ScmException - the scm exception

Method Detail

initClient

protected void initClient()
                   throws org.apache.maven.scm.ScmException

Initialize an instance of the Perforce client from the server with a specified client name. Set the current client on the server.

Throws:: org.apache.maven.scm.ScmException - the scm exception

cleanClient

protected void cleanClient()

Cleanup the Perforce client instance.

initP4

protected void initP4()
               throws org.apache.maven.scm.ScmException

Description copied from class: P4Executor

Initialize Perforce server and client instances. This should be implemented in the Perforce server and client subclasses.

Overrides:: initP4 in class P4ServerExecutor

Throws:: org.apache.maven.scm.ScmException - the scm exception
See Also:: P4Executor.initP4()

cleanP4

protected void cleanP4()
                throws org.apache.maven.scm.ScmException