locked results from the CPAN

Artifactory-Client

view release on metacpan or search on metacpan

Retrieves file compliance info of a given path.

## delete\_item( $path )

Delete $path on artifactory.

## copy\_item( from => $from, to => $to, dry => 1, suppressLayouts => 0/1, failFast => 0/1 )

Copies an artifact from $from to $to.  Note that for this particular API call, the $from and $to must include repository
names as copy source and destination may be different repositories.  You can also supply dry, suppressLayouts and
failFast values as specified in the documentation.

## move\_item( from => $from, to => $to, dry => 1, suppressLayouts => 0/1, failFast => 0/1 )

Moves an artifact from $from to $to.  Note that for this particular API call, the $from and $to must include repository
names as copy source and destination may be different repositories.  You can also supply dry, suppressLayouts and
failFast values as specified in the documentation.

## get\_repository\_replication\_configuration

Get repository replication configuration

## set\_repository\_replication\_configuration( $payload )

Set repository replication configuration

## update\_repository\_replication\_configuration( $payload )

Update repository replication configuration

## delete\_repository\_replication\_configuration

Delete repository replication configuration

## scheduled\_replication\_status

Gets scheduled replication status of a repository

## pull\_push\_replication( payload => $payload, path => $path )

Schedules immediate content replication between two Artifactory instances

## create\_or\_replace\_local\_multi\_push\_replication( $payload )

Creates or replaces a local multi-push replication configuration. Supported by local and local-cached repositories

## update\_local\_multi\_push\_replication( $payload )

Updates a local multi-push replication configuration. Supported by local and local-cached repositories

## delete\_local\_multi\_push\_replication( $url )

Deletes a local multi-push replication configuration. Supported by local and local-cached repositories

## enable\_or\_disable\_multiple\_replications( 'enable|disable', include => \[ \], exclude => \[ \] )

Enables/disables multiple replication tasks by repository or Artifactory server based in include and exclude patterns.

## get\_global\_system\_replication\_configuration

Returns the global system replication configuration status, i.e. if push and pull replications are blocked or unblocked.

## get\_remote\_repositories\_registered\_for\_replication

Returns a list of all the listeners subscribed for event-based pull replication on the specified repository.

## block\_system\_replication( push => 'false', pull => 'true' )

Blocks replications globally. Push and pull are true by default. If false, replication for the corresponding type is not
blocked.

## unblock\_system\_replication( push => 'false', pull => 'true' )

Unblocks replications globally. Push and pull are true by default. If false, replication for the corresponding type is
not unblocked.

## artifact\_sync\_download( $path, content => 'progress', mark => 1000 )

Downloads an artifact with or without returning the actual content to the client. When tracking the progress marks are
printed (by default every 1024 bytes). This is extremely useful if you want to trigger downloads on a remote Artifactory
server, for example to force eager cache population of large artifacts, but want to avoid the bandwidth consumption
involved in transferring the artifacts to the triggering client. If no content parameter is specified the file content
is downloaded to the client.

## file\_list( $dir, %opts )

Get a flat (the default) or deep listing of the files and folders (not included by default) within a folder

## get\_background\_tasks

Retrieves list of background tasks currently scheduled or running in Artifactory. In HA, the nodeId is added to each
task. Task can be in one of few states: scheduled, running, stopped, canceled. Running task also shows the task start
time.

## empty\_trash\_can

Empties the trash can permanently deleting all its current contents.

## delete\_item\_from\_trash\_can($path)

Permanently deletes an item from the trash can.

## restore\_item\_from\_trash\_can( $from, $to )

Restore an item from the trash can.

## optimize\_system\_storage

Raises a flag to invoke balancing between redundant storage units of a sharded filestore following the next garbage
collection.

# SEARCHES

## artifactory\_query\_language( $aql\_statement )

Flexible and high performance search using Artifactory Query Language (AQL).

## artifact\_search( name => $name, repos => \[ @repos \], result\_detail => \[qw(info properties)\], )

Artifact search by part of file name

## archive\_entry\_search( name => $name, repos => \[ @repos \] )

Search archive entries for classes or any other jar resources

## gavc\_search( g => 'foo', c => 'bar', result\_detail => \[qw(info properties)\], )

Search by Maven coordinates: groupId, artifactId, version & classifier

## property\_search( p => \[ 'v1', 'v2' \], repos => \[ 'repo1', 'repo2' \], result\_detail => \[qw(info properties)\], )

Search by properties

## checksum\_search( md5 => '12345', repos => \[ 'repo1', 'repo2' \], result\_detail => \[qw(info properties)\], )

README.md view on Meta::CPAN


Get the users list

## get\_user\_details( $user )

Get the details of an Artifactory user

## get\_user\_encrypted\_password

Get the encrypted password of the authenticated requestor

## create\_or\_replace\_user( $user, %args )

Creates a new user in Artifactory or replaces an existing user

## update\_user( $user, %args )

Updates an exiting user in Artifactory with the provided user details

## delete\_user( $user )

Removes an Artifactory user

## expire\_password\_for\_a\_single\_user( $user )

Expires a user's password

## expire\_password\_for\_multiple\_users( $user1, $user2 )

Expires password for a list of users

## expire\_password\_for\_all\_users

Expires password for all users

## unexpire\_password\_for\_a\_single\_user( $user )

Unexpires a user's password

## change\_password( user => 'david', oldPassword => 'foo', newPassword => 'bar' )

Changes a user's password

## get\_password\_expiration\_policy

Retrieves the password expiration policy

## set\_password\_expiration\_policy

Sets the password expiration policy

## configure\_user\_lock\_policy( enabled => 'true|false', loginAttempts => $num )

Configures the user lock policy that locks users out of their account if the number of repeated incorrect login attempts
exceeds the configured maximum allowed.

## retrieve\_user\_lock\_policy

Retrieves the currently configured user lock policy.

## get\_locked\_out\_users

If locking out users is enabled, lists all users that were locked out due to recurrent incorrect login attempts.

## unlock\_locked\_out\_user

Unlocks a single user that was locked out due to recurrent incorrect login attempts.

## unlock\_locked\_out\_users

Unlocks a list of users that were locked out due to recurrent incorrect login attempts.

## unlock\_all\_locked\_out\_users

Unlocks all users that were locked out due to recurrent incorrect login attempts.

## create\_api\_key( apiKey => '3OloposOtVFyCMrT+cXmCAScmVMPrSYXkWIjiyDCXsY=' )

Create an API key for the current user

## get\_api\_key

Get the current user's own API key

## revoke\_api\_key

Revokes the current user's API key

## revoke\_user\_api\_key

Revokes the API key of another user

## revoke\_all\_api\_keys

Revokes all API keys currently defined in the system

## get\_groups

Get the groups list

## get\_group\_details( $group )

Get the details of an Artifactory Group

## create\_or\_replace\_group( $group, %args )

Creates a new group in Artifactory or replaces an existing group

## update\_group( $group, %args )

Updates an exiting group in Artifactory with the provided group details

## delete\_group( $group )

Removes an Artifactory group

## get\_permission\_targets

Get the permission targets list

## get\_permission\_target\_details( $name )

Get the details of an Artifactory Permission Target

## create\_or\_replace\_permission\_target( $name, %args )

Creates a new permission target in Artifactory or replaces an existing permission target

## delete\_permission\_target( $name )

Deletes an Artifactory permission target

## effective\_item\_permissions( $path )

Returns a list of effective permissions for the specified item (file or folder)

README.md view on Meta::CPAN


Starts the SHA-256 migration process.

## stop\_sha256\_migration\_task( "sleepIntervalMillis" => 5000, etc etc )

Stops the SHA-256 migration process

# PLUGINS

## execute\_plugin\_code( $execution\_name, $params, $async )

Executes a named execution closure found in the executions section of a user plugin

## retrieve\_all\_available\_plugin\_info

Retrieves all available user plugin information (subject to the permissions of the provided credentials)

## retrieve\_plugin\_info\_of\_a\_certain\_type( $type )

Retrieves all available user plugin information (subject to the permissions of the provided credentials) of the
specified type

## retrieve\_build\_staging\_strategy( strategyName => 'strategy1', buildName => 'build1', %args )

Retrieves a build staging strategy defined by a user plugin

## execute\_build\_promotion( promotionName => 'promotion1', buildName => 'build1', buildNumber => 3, %args )

Executes a named promotion closure found in the promotions section of a user plugin

## reload\_plugins

Reloads user plugins if there are modifications since the last user plugins reload. Works regardless of the automatic
user plugins refresh interval

# IMPORT & EXPORT

## import\_repository\_content( path => 'foobar', repo => 'repo', metadata => 1, verbose => 0 )

Import one or more repositories

## import\_system\_settings\_example

Returned default Import Settings JSON

## full\_system\_import( importPath => '/import/path', includeMetadata => 'false' etc )

Import full system from a server local Artifactory export directory

## export\_system\_settings\_example

Returned default Export Settings JSON

## export\_system( exportPath => '/export/path', includeMetadata => 'true' etc )

Export full system to a server local directory

## ignore\_xray\_alert( $path )

Sets an alert to be ignored until next time the repository hosting the artifact about which the alert was issued, is scanned. Note that this endpoint does not
affect artifacts that are blocked because they have not been scanned at all.

## allow\_download\_of\_blocked\_artifacts( 'true'|'false' )

When a repository is configured to block downloads of artifacts, you may override that configuration (and allow download of blocked artifacts). Note that this
setting cannot override the blocking of unscanned artifacts.

## allow\_download\_when\_xray\_is\_unavailable( 'true'|'false' )

You may configure Artifactory to block downloads of artifacts when the connected Xray instance is unavailable. This endpoint lets you override that
configuration (and allow download of artifacts).

## create\_bundle( %hash of data structure )

Create a new support bundle

## list\_bundles

Lists previously created bundle currently stored in the system

## get\_bundle\_metadata( $name )

Downloads a previously created bundle currently stored in the system

## get\_bundle( $name )

Downloads a previously created bundle currently stored in the system

## delete\_bundle( $name )

Deletes a previously created bundle from the system.

# AUTHOR

Satoshi Yagi, `<satoshi.yagi at yahoo.com>`

# BUGS

Please report any bugs or feature requests to `bug-artifactory-client at
rt.cpan.org`, or through the web interface at
[http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Artifactory-Client](http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Artifactory-Client).  I will
be notified, and then you'll automatically be notified of progress on your bug
as I make changes.

# SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Artifactory::Client

You can also look for information at:

- RT: CPAN's request tracker (report bugs here)

    [http://rt.cpan.org/NoAuth/Bugs.html?Dist=Artifactory-Client](http://rt.cpan.org/NoAuth/Bugs.html?Dist=Artifactory-Client)

- AnnoCPAN: Annotated CPAN documentation

    [http://annocpan.org/dist/Artifactory-Client](http://annocpan.org/dist/Artifactory-Client)

- CPAN Ratings

    [http://cpanratings.perl.org/d/Artifactory-Client](http://cpanratings.perl.org/d/Artifactory-Client)

- Search CPAN

( run in 1.149 second using v1.01-cache-2.11-cpan-97f6503c9c8 )