LogoutDelegator (p4java 2024.1.2612262 API)

java.lang.Object
- com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
- - com.perforce.p4java.impl.mapbased.server.cmd.LogoutDelegator

All Implemented Interfaces:: ILogoutDelegator

public class LogoutDelegator
extends BaseDelegator
implements ILogoutDelegator

Handles the 'p4 logout' command.

Field Summary
- Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
  MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors
Constructor Description

LogoutDelegator(IOptionsServer server)
Instantiates a new logout delegator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`logout()`	Log the current Perforce user out of a Perforce server session.
`void`	`logout(LoginOptions opts)`	Log the current Perforce user out of a Perforce server session.

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

- Constructor Detail
  - LogoutDelegator
```
public LogoutDelegator(IOptionsServer server)
```
    Instantiates a new logout delegator.
    
    Parameters:
    
    server - the server
- Method Detail
  - logout
```
public void logout()
            throws ConnectionException,
                   RequestException,
                   AccessException,
                   ConfigException
```
    Description copied from interface: ILogoutDelegator
    
    Log the current Perforce user out of a Perforce server session.
    
    Specified by:
    
    logout in interface ILogoutDelegator
    
    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
    
    ConfigException - if the p4tickets file could not be updated successfully
  - logout
```
public void logout(LoginOptions opts)
            throws P4JavaException
```
    Description copied from interface: ILogoutDelegator
    
    Log the current Perforce user out of a Perforce server session.
    
    Specified by:
    
    logout in interface ILogoutDelegator
    
    Parameters:
    
    opts - currently ignored; can be null.
    
    Throws:
    
    P4JavaException - if any error occurs in the processing of this method.