init III

Perl OTRS/Kernel/GenericInterface/Operation/Session/SessionCreate.pm

@@ -0,0 +1,135 @@
+# --
+# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
+# --
+# This software comes with ABSOLUTELY NO WARRANTY. For details, see
+# the enclosed file COPYING for license information (GPL). If you
+# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
+# --
+
+package Kernel::GenericInterface::Operation::Session::SessionCreate;
+
+use strict;
+use warnings;
+
+use Kernel::System::VariableCheck qw(IsStringWithData IsHashRefWithData);
+
+use parent qw(
+    Kernel::GenericInterface::Operation::Common
+    Kernel::GenericInterface::Operation::Session::Common
+);
+
+our $ObjectManagerDisabled = 1;
+
+=head1 NAME
+
+Kernel::GenericInterface::Operation::Session::SessionCreate - GenericInterface Session Create Operation backend
+
+=head1 PUBLIC INTERFACE
+
+=head2 new()
+
+usually, you want to create an instance of this
+by using Kernel::GenericInterface::Operation->new();
+
+=cut
+
+sub new {
+    my ( $Type, %Param ) = @_;
+
+    my $Self = {};
+    bless( $Self, $Type );
+
+    # check needed objects
+    for my $Needed (
+        qw(DebuggerObject WebserviceID)
+        )
+    {
+        if ( !$Param{$Needed} ) {
+
+            return {
+                Success      => 0,
+                ErrorMessage => "Got no $Needed!"
+            };
+        }
+
+        $Self->{$Needed} = $Param{$Needed};
+    }
+
+    return $Self;
+}
+
+=head2 Run()
+
+Retrieve a new session id value.
+
+    my $Result = $OperationObject->Run(
+        Data => {
+            UserLogin         => 'Agent1',
+            CustomerUserLogin => 'Customer1',       # optional, provide UserLogin or CustomerUserLogin
+            Password          => 'some password',   # plain text password
+        },
+    );
+
+    $Result = {
+        Success      => 1,                                # 0 or 1
+        ErrorMessage => '',                               # In case of an error
+        Data         => {
+            SessionID => $SessionID,
+        },
+    };
+
+=cut
+
+sub Run {
+    my ( $Self, %Param ) = @_;
+
+    # check needed stuff
+    if ( !IsHashRefWithData( $Param{Data} ) ) {
+
+        return $Self->ReturnError(
+            ErrorCode    => 'SessionCreate.MissingParameter',
+            ErrorMessage => "SessionCreate: The request is empty!",
+        );
+    }
+
+    for my $Needed (qw( Password )) {
+        if ( !$Param{Data}->{$Needed} ) {
+
+            return $Self->ReturnError(
+                ErrorCode    => 'SessionCreate.MissingParameter',
+                ErrorMessage => "SessionCreate: $Needed parameter is missing!",
+            );
+        }
+    }
+
+    my $SessionID = $Self->CreateSessionID(
+        %Param,
+    );
+
+    if ( !$SessionID ) {
+
+        return $Self->ReturnError(
+            ErrorCode    => 'SessionCreate.AuthFail',
+            ErrorMessage => "SessionCreate: Authorization failing!",
+        );
+    }
+
+    return {
+        Success => 1,
+        Data    => {
+            SessionID => $SessionID,
+        },
+    };
+}
+
+1;
+
+=head1 TERMS AND CONDITIONS
+
+This software is part of the OTRS project (L<https://otrs.org/>).
+
+This software comes with ABSOLUTELY NO WARRANTY. For details, see
+the enclosed file COPYING for license information (GPL). If you
+did not receive this file, see L<https://www.gnu.org/licenses/gpl-3.0.txt>.
+
+=cut